EHI Export Implementation Guide
0.1.0 - ci-build
EHI Export Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/Authorization | Version: 0.1.0 | |||
Draft as of 2024-02-05 | Computable Name: EHIAuthorization |
This is a PointClickCare specific implementation of Patient Prior Authorization information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DomainResource
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Authorization | 0..* | DomainResource | Authorization | |
comments | Σ | 0..1 | string | Additional comments if available |
endDate | Σ | 0..1 | dateTime | The effective end date for prior authorization |
exclusions | Σ | 0..1 | string | Exclusion remarks |
identifier | Σ | 1..1 | Identifier | Identification key |
insurance | Σ | 1..1 | Reference(Location | Organization) | Insuring party |
nextReviewDate | Σ | 0..1 | dateTime | The next review date |
payer | Σ | 1..1 | Reference(Location | Organization) | Payer party |
requestStatus | Σ | 1..1 | string | Status of the review |
requestType | Σ | 1..1 | string | Type of request |
startDate | Σ | 1..1 | dateTime | The effective start date for prior authorization |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Authorization | 0..* | DomainResource | Authorization | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
comments | Σ | 0..1 | string | Additional comments if available |
endDate | Σ | 0..1 | dateTime | The effective end date for prior authorization |
exclusions | Σ | 0..1 | string | Exclusion remarks |
identifier | Σ | 1..1 | Identifier | Identification key |
insurance | Σ | 1..1 | Reference(Location | Organization) | Insuring party |
nextReviewDate | Σ | 0..1 | dateTime | The next review date |
payer | Σ | 1..1 | Reference(Location | Organization) | Payer party |
requestStatus | Σ | 1..1 | string | Status of the review |
requestType | Σ | 1..1 | string | Type of request |
startDate | Σ | 1..1 | dateTime | The effective start date for prior authorization |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Authorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Authorization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Authorization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Authorization | 0..* | DomainResource | Authorization | |||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
comments | Σ | 0..1 | string | Additional comments if available | ||||
endDate | Σ | 0..1 | dateTime | The effective end date for prior authorization | ||||
exclusions | Σ | 0..1 | string | Exclusion remarks | ||||
identifier | Σ | 1..1 | Identifier | Identification key | ||||
insurance | Σ | 1..1 | Reference(Location | Organization) | Insuring party | ||||
nextReviewDate | Σ | 0..1 | dateTime | The next review date | ||||
payer | Σ | 1..1 | Reference(Location | Organization) | Payer party | ||||
requestStatus | Σ | 1..1 | string | Status of the review | ||||
requestType | Σ | 1..1 | string | Type of request | ||||
startDate | Σ | 1..1 | dateTime | The effective start date for prior authorization | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Authorization.language | preferred | CommonLanguages
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Authorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Authorization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Authorization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DomainResource
Differential View
This structure is derived from DomainResource
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Authorization | 0..* | DomainResource | Authorization | |
comments | Σ | 0..1 | string | Additional comments if available |
endDate | Σ | 0..1 | dateTime | The effective end date for prior authorization |
exclusions | Σ | 0..1 | string | Exclusion remarks |
identifier | Σ | 1..1 | Identifier | Identification key |
insurance | Σ | 1..1 | Reference(Location | Organization) | Insuring party |
nextReviewDate | Σ | 0..1 | dateTime | The next review date |
payer | Σ | 1..1 | Reference(Location | Organization) | Payer party |
requestStatus | Σ | 1..1 | string | Status of the review |
requestType | Σ | 1..1 | string | Type of request |
startDate | Σ | 1..1 | dateTime | The effective start date for prior authorization |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Authorization | 0..* | DomainResource | Authorization | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
comments | Σ | 0..1 | string | Additional comments if available |
endDate | Σ | 0..1 | dateTime | The effective end date for prior authorization |
exclusions | Σ | 0..1 | string | Exclusion remarks |
identifier | Σ | 1..1 | Identifier | Identification key |
insurance | Σ | 1..1 | Reference(Location | Organization) | Insuring party |
nextReviewDate | Σ | 0..1 | dateTime | The next review date |
payer | Σ | 1..1 | Reference(Location | Organization) | Payer party |
requestStatus | Σ | 1..1 | string | Status of the review |
requestType | Σ | 1..1 | string | Type of request |
startDate | Σ | 1..1 | dateTime | The effective start date for prior authorization |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Authorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Authorization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Authorization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Authorization | 0..* | DomainResource | Authorization | |||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
comments | Σ | 0..1 | string | Additional comments if available | ||||
endDate | Σ | 0..1 | dateTime | The effective end date for prior authorization | ||||
exclusions | Σ | 0..1 | string | Exclusion remarks | ||||
identifier | Σ | 1..1 | Identifier | Identification key | ||||
insurance | Σ | 1..1 | Reference(Location | Organization) | Insuring party | ||||
nextReviewDate | Σ | 0..1 | dateTime | The next review date | ||||
payer | Σ | 1..1 | Reference(Location | Organization) | Payer party | ||||
requestStatus | Σ | 1..1 | string | Status of the review | ||||
requestType | Σ | 1..1 | string | Type of request | ||||
startDate | Σ | 1..1 | dateTime | The effective start date for prior authorization | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Authorization.language | preferred | CommonLanguages
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Authorization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Authorization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Authorization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Authorization | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DomainResource
Other representations of profile: CSV, Excel, Schematron