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/Order | Version: 0.1.0 | |||
Draft as of 2024-02-05 | Computable Name: EHIOrder |
Non-pharmacy related orders, such as Immunization, Diet, Lab or Diagnostic
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DomainResource
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Order | 0..* | DomainResource | Order | |
communicationMethod | Σ | 0..1 | string | The method through which the order was communicated |
description | Σ | 0..1 | string | Additional description |
dietSupplement | Σ | 0..1 | string | Information about the diet supplements |
dietTexture | Σ | 0..1 | string | The texture of the diet being order |
dietType | Σ | 0..1 | string | For diet order, the corresponding type |
fluidConsistency | Σ | 0..1 | string | The consistency of the fluid of the diet being order |
identifier | Σ | 1..1 | Identifier | Identification key |
orderDate | Σ | 1..1 | dateTime | The time when the order was created |
orderSummary | Σ | 0..1 | string | Summarized details of the order |
orderType | Σ | 1..1 | string | Indicates the type of order being represented |
orderedBy | Σ | 1..1 | string | Entity that put this order |
pointOfCareTestDevice | Σ | 0..1 | string | Point of Care Test Device |
sourceDetails | Σ | 0..1 | string | Source Details |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
typeOfDiagnostic | Σ | 0..1 | string | Type of Diagnosistic |
typeOfLab | Σ | 0..1 | string | Type of lab for Lab Order |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Order | 0..* | DomainResource | Order | |
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 |
communicationMethod | Σ | 0..1 | string | The method through which the order was communicated |
description | Σ | 0..1 | string | Additional description |
dietSupplement | Σ | 0..1 | string | Information about the diet supplements |
dietTexture | Σ | 0..1 | string | The texture of the diet being order |
dietType | Σ | 0..1 | string | For diet order, the corresponding type |
fluidConsistency | Σ | 0..1 | string | The consistency of the fluid of the diet being order |
identifier | Σ | 1..1 | Identifier | Identification key |
orderDate | Σ | 1..1 | dateTime | The time when the order was created |
orderSummary | Σ | 0..1 | string | Summarized details of the order |
orderType | Σ | 1..1 | string | Indicates the type of order being represented |
orderedBy | Σ | 1..1 | string | Entity that put this order |
pointOfCareTestDevice | Σ | 0..1 | string | Point of Care Test Device |
sourceDetails | Σ | 0..1 | string | Source Details |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
typeOfDiagnostic | Σ | 0..1 | string | Type of Diagnosistic |
typeOfLab | Σ | 0..1 | string | Type of lab for Lab Order |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Order | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Order | 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 | Order | 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 | Order | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Order | 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 | ||||
---|---|---|---|---|---|---|---|---|
Order | 0..* | DomainResource | Order | |||||
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 | ||||
communicationMethod | Σ | 0..1 | string | The method through which the order was communicated | ||||
description | Σ | 0..1 | string | Additional description | ||||
dietSupplement | Σ | 0..1 | string | Information about the diet supplements | ||||
dietTexture | Σ | 0..1 | string | The texture of the diet being order | ||||
dietType | Σ | 0..1 | string | For diet order, the corresponding type | ||||
fluidConsistency | Σ | 0..1 | string | The consistency of the fluid of the diet being order | ||||
identifier | Σ | 1..1 | Identifier | Identification key | ||||
orderDate | Σ | 1..1 | dateTime | The time when the order was created | ||||
orderSummary | Σ | 0..1 | string | Summarized details of the order | ||||
orderType | Σ | 1..1 | string | Indicates the type of order being represented | ||||
orderedBy | Σ | 1..1 | string | Entity that put this order | ||||
pointOfCareTestDevice | Σ | 0..1 | string | Point of Care Test Device | ||||
sourceDetails | Σ | 0..1 | string | Source Details | ||||
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
typeOfDiagnostic | Σ | 0..1 | string | Type of Diagnosistic | ||||
typeOfLab | Σ | 0..1 | string | Type of lab for Lab Order | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Order.language | preferred | CommonLanguages
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Order | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Order | 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 | Order | 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 | Order | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Order | 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 |
---|---|---|---|---|
Order | 0..* | DomainResource | Order | |
communicationMethod | Σ | 0..1 | string | The method through which the order was communicated |
description | Σ | 0..1 | string | Additional description |
dietSupplement | Σ | 0..1 | string | Information about the diet supplements |
dietTexture | Σ | 0..1 | string | The texture of the diet being order |
dietType | Σ | 0..1 | string | For diet order, the corresponding type |
fluidConsistency | Σ | 0..1 | string | The consistency of the fluid of the diet being order |
identifier | Σ | 1..1 | Identifier | Identification key |
orderDate | Σ | 1..1 | dateTime | The time when the order was created |
orderSummary | Σ | 0..1 | string | Summarized details of the order |
orderType | Σ | 1..1 | string | Indicates the type of order being represented |
orderedBy | Σ | 1..1 | string | Entity that put this order |
pointOfCareTestDevice | Σ | 0..1 | string | Point of Care Test Device |
sourceDetails | Σ | 0..1 | string | Source Details |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
typeOfDiagnostic | Σ | 0..1 | string | Type of Diagnosistic |
typeOfLab | Σ | 0..1 | string | Type of lab for Lab Order |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Order | 0..* | DomainResource | Order | |
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 |
communicationMethod | Σ | 0..1 | string | The method through which the order was communicated |
description | Σ | 0..1 | string | Additional description |
dietSupplement | Σ | 0..1 | string | Information about the diet supplements |
dietTexture | Σ | 0..1 | string | The texture of the diet being order |
dietType | Σ | 0..1 | string | For diet order, the corresponding type |
fluidConsistency | Σ | 0..1 | string | The consistency of the fluid of the diet being order |
identifier | Σ | 1..1 | Identifier | Identification key |
orderDate | Σ | 1..1 | dateTime | The time when the order was created |
orderSummary | Σ | 0..1 | string | Summarized details of the order |
orderType | Σ | 1..1 | string | Indicates the type of order being represented |
orderedBy | Σ | 1..1 | string | Entity that put this order |
pointOfCareTestDevice | Σ | 0..1 | string | Point of Care Test Device |
sourceDetails | Σ | 0..1 | string | Source Details |
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference |
typeOfDiagnostic | Σ | 0..1 | string | Type of Diagnosistic |
typeOfLab | Σ | 0..1 | string | Type of lab for Lab Order |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Order | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Order | 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 | Order | 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 | Order | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Order | 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 | ||||
---|---|---|---|---|---|---|---|---|
Order | 0..* | DomainResource | Order | |||||
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 | ||||
communicationMethod | Σ | 0..1 | string | The method through which the order was communicated | ||||
description | Σ | 0..1 | string | Additional description | ||||
dietSupplement | Σ | 0..1 | string | Information about the diet supplements | ||||
dietTexture | Σ | 0..1 | string | The texture of the diet being order | ||||
dietType | Σ | 0..1 | string | For diet order, the corresponding type | ||||
fluidConsistency | Σ | 0..1 | string | The consistency of the fluid of the diet being order | ||||
identifier | Σ | 1..1 | Identifier | Identification key | ||||
orderDate | Σ | 1..1 | dateTime | The time when the order was created | ||||
orderSummary | Σ | 0..1 | string | Summarized details of the order | ||||
orderType | Σ | 1..1 | string | Indicates the type of order being represented | ||||
orderedBy | Σ | 1..1 | string | Entity that put this order | ||||
pointOfCareTestDevice | Σ | 0..1 | string | Point of Care Test Device | ||||
sourceDetails | Σ | 0..1 | string | Source Details | ||||
subject | Σ | 1..1 | Reference(Patient) | Patient subject reference | ||||
typeOfDiagnostic | Σ | 0..1 | string | Type of Diagnosistic | ||||
typeOfLab | Σ | 0..1 | string | Type of lab for Lab Order | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Order.language | preferred | CommonLanguages
|
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Order | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Order | 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 | Order | 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 | Order | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Order | 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