EHI Export Implementation Guide
0.1.0 - ci-build

EHI Export Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Order

Official URL: https://ehi-export.pointclickcare.com//StructureDefinition/Order Version: 0.1.0
Draft as of 2025-04-11 Computable Name: EHIOrder

Non-pharmacy related orders, such as Immunization, Diet, Lab or Diagnostic.

Notes

The id element is not displayed in the snapshot tables. Refer to the detailed descriptions for the full definition.

Usage:

  • This Resource is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Order 0..* DomainResource Order
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
... text 0..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... category Σ 0..1 string Category of the order
... communicationMethod Σ 0..1 string The method through which the order was communicated
... createdBy Σ 0..1 string Created By
... createdDate Σ 0..1 dateTime Date the order was created
... 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
... endDate Σ 0..1 dateTime End date of the order
... fluidConsistency Σ 0..1 string The consistency of the fluid of the diet being order
... identifier Σ 1..1 Identifier Identification key
... orderClassId Σ 1..1 string Order Class Id
... orderDate Σ 1..1 dateTime The time when the order was created
... orderStatus Σ 1..1 code Status of the order
Binding: Order Status Value Set (required)
... 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
... physicianId Σ 0..1 string Physician Id
... pointOfCareTestDevice Σ 0..1 string Point of Care Test Device
... revisionBy Σ 0..1 string Revision By
... revisionDate Σ 0..1 dateTime Revision Date
... sourceDetails Σ 0..1 string Source Details
... startDate Σ 0..1 dateTime Start date of the order
... subject Σ 1..1 Reference(Patient) Patient subject reference
... typeOfDiagnostic Σ 0..1 string Type of Diagnostic
... typeOfLab Σ 0..1 string Type of lab for Lab Order
... verified Σ 0..1 string Indicates if the order has been verified

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Order.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Order.orderStatusrequiredOrderStatusVS (a valid code from Order Status Code System)
https://ehi-export.pointclickcare.com/site/ValueSet-order-status-vs.html
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrderIf 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-4errorOrderIf 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-5errorOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. Order 0..* DomainResource Order
... category Σ 0..1 string Category of the order
... communicationMethod Σ 0..1 string The method through which the order was communicated
... createdBy Σ 0..1 string Created By
... createdDate Σ 0..1 dateTime Date the order was created
... 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
... endDate Σ 0..1 dateTime End date of the order
... fluidConsistency Σ 0..1 string The consistency of the fluid of the diet being order
... identifier Σ 1..1 Identifier Identification key
... orderClassId Σ 1..1 string Order Class Id
... orderDate Σ 1..1 dateTime The time when the order was created
... orderStatus Σ 1..1 code Status of the order
Binding: Order Status Value Set (required)
... 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
... physicianId Σ 0..1 string Physician Id
... pointOfCareTestDevice Σ 0..1 string Point of Care Test Device
... revisionBy Σ 0..1 string Revision By
... revisionDate Σ 0..1 dateTime Revision Date
... sourceDetails Σ 0..1 string Source Details
... startDate Σ 0..1 dateTime Start date of the order
... subject Σ 1..1 Reference(Patient) Patient subject reference
... typeOfDiagnostic Σ 0..1 string Type of Diagnostic
... typeOfLab Σ 0..1 string Type of lab for Lab Order
... verified Σ 0..1 string Indicates if the order has been verified

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Order.orderStatusrequiredOrderStatusVS (a valid code from Order Status Code System)
https://ehi-export.pointclickcare.com/site/ValueSet-order-status-vs.html
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... category Σ 0..1 string Category of the order
... communicationMethod Σ 0..1 string The method through which the order was communicated
... createdBy Σ 0..1 string Created By
... createdDate Σ 0..1 dateTime Date the order was created
... 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
... endDate Σ 0..1 dateTime End date of the order
... fluidConsistency Σ 0..1 string The consistency of the fluid of the diet being order
... identifier Σ 1..1 Identifier Identification key
... orderClassId Σ 1..1 string Order Class Id
... orderDate Σ 1..1 dateTime The time when the order was created
... orderStatus Σ 1..1 code Status of the order
Binding: Order Status Value Set (required)
... 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
... physicianId Σ 0..1 string Physician Id
... pointOfCareTestDevice Σ 0..1 string Point of Care Test Device
... revisionBy Σ 0..1 string Revision By
... revisionDate Σ 0..1 dateTime Revision Date
... sourceDetails Σ 0..1 string Source Details
... startDate Σ 0..1 dateTime Start date of the order
... subject Σ 1..1 Reference(Patient) Patient subject reference
... typeOfDiagnostic Σ 0..1 string Type of Diagnostic
... typeOfLab Σ 0..1 string Type of lab for Lab Order
... verified Σ 0..1 string Indicates if the order has been verified

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Order.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Order.orderStatusrequiredOrderStatusVS (a valid code from Order Status Code System)
https://ehi-export.pointclickcare.com/site/ValueSet-order-status-vs.html
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrderIf 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-4errorOrderIf 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-5errorOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(7 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Order 0..* DomainResource Order
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
... text 0..1 Narrative Text summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... category Σ 0..1 string Category of the order
... communicationMethod Σ 0..1 string The method through which the order was communicated
... createdBy Σ 0..1 string Created By
... createdDate Σ 0..1 dateTime Date the order was created
... 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
... endDate Σ 0..1 dateTime End date of the order
... fluidConsistency Σ 0..1 string The consistency of the fluid of the diet being order
... identifier Σ 1..1 Identifier Identification key
... orderClassId Σ 1..1 string Order Class Id
... orderDate Σ 1..1 dateTime The time when the order was created
... orderStatus Σ 1..1 code Status of the order
Binding: Order Status Value Set (required)
... 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
... physicianId Σ 0..1 string Physician Id
... pointOfCareTestDevice Σ 0..1 string Point of Care Test Device
... revisionBy Σ 0..1 string Revision By
... revisionDate Σ 0..1 dateTime Revision Date
... sourceDetails Σ 0..1 string Source Details
... startDate Σ 0..1 dateTime Start date of the order
... subject Σ 1..1 Reference(Patient) Patient subject reference
... typeOfDiagnostic Σ 0..1 string Type of Diagnostic
... typeOfLab Σ 0..1 string Type of lab for Lab Order
... verified Σ 0..1 string Indicates if the order has been verified

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Order.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Order.orderStatusrequiredOrderStatusVS (a valid code from Order Status Code System)
https://ehi-export.pointclickcare.com/site/ValueSet-order-status-vs.html
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrderIf 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-4errorOrderIf 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-5errorOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. Order 0..* DomainResource Order
... category Σ 0..1 string Category of the order
... communicationMethod Σ 0..1 string The method through which the order was communicated
... createdBy Σ 0..1 string Created By
... createdDate Σ 0..1 dateTime Date the order was created
... 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
... endDate Σ 0..1 dateTime End date of the order
... fluidConsistency Σ 0..1 string The consistency of the fluid of the diet being order
... identifier Σ 1..1 Identifier Identification key
... orderClassId Σ 1..1 string Order Class Id
... orderDate Σ 1..1 dateTime The time when the order was created
... orderStatus Σ 1..1 code Status of the order
Binding: Order Status Value Set (required)
... 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
... physicianId Σ 0..1 string Physician Id
... pointOfCareTestDevice Σ 0..1 string Point of Care Test Device
... revisionBy Σ 0..1 string Revision By
... revisionDate Σ 0..1 dateTime Revision Date
... sourceDetails Σ 0..1 string Source Details
... startDate Σ 0..1 dateTime Start date of the order
... subject Σ 1..1 Reference(Patient) Patient subject reference
... typeOfDiagnostic Σ 0..1 string Type of Diagnostic
... typeOfLab Σ 0..1 string Type of lab for Lab Order
... verified Σ 0..1 string Indicates if the order has been verified

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Order.orderStatusrequiredOrderStatusVS (a valid code from Order Status Code System)
https://ehi-export.pointclickcare.com/site/ValueSet-order-status-vs.html
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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.

Additional BindingsPurpose
AllLanguages Max Binding
... 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
... category Σ 0..1 string Category of the order
... communicationMethod Σ 0..1 string The method through which the order was communicated
... createdBy Σ 0..1 string Created By
... createdDate Σ 0..1 dateTime Date the order was created
... 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
... endDate Σ 0..1 dateTime End date of the order
... fluidConsistency Σ 0..1 string The consistency of the fluid of the diet being order
... identifier Σ 1..1 Identifier Identification key
... orderClassId Σ 1..1 string Order Class Id
... orderDate Σ 1..1 dateTime The time when the order was created
... orderStatus Σ 1..1 code Status of the order
Binding: Order Status Value Set (required)
... 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
... physicianId Σ 0..1 string Physician Id
... pointOfCareTestDevice Σ 0..1 string Point of Care Test Device
... revisionBy Σ 0..1 string Revision By
... revisionDate Σ 0..1 dateTime Revision Date
... sourceDetails Σ 0..1 string Source Details
... startDate Σ 0..1 dateTime Start date of the order
... subject Σ 1..1 Reference(Patient) Patient subject reference
... typeOfDiagnostic Σ 0..1 string Type of Diagnostic
... typeOfLab Σ 0..1 string Type of lab for Lab Order
... verified Σ 0..1 string Indicates if the order has been verified

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Order.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Order.orderStatusrequiredOrderStatusVS (a valid code from Order Status Code System)
https://ehi-export.pointclickcare.com/site/ValueSet-order-status-vs.html
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrderIf 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-4errorOrderIf 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-5errorOrderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(7 nested mandatory elements)

 

Other representations of profile: CSV, Excel, Schematron