v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: ORU_R01 - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the ORUR01 logical model.

Guidance on how to interpret the contents of this table can be found here

0. ORU_R01
Definition

Observation Message

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. ORU_R01.MSH
ShortMessage Header
Control1..1
TypeMSH
Must Supporttrue
4. ORU_R01.ARV
ShortAccess Restriction
Control0..*
TypeARV
6. ORU_R01.SFT
ShortSoftware Segment
Control0..*
TypeSFT
8. ORU_R01.UAC
ShortUser Authentication Credential Segment
Control0..1
TypeUAC
10. ORU_R01.PATIENT-RESULT
ShortPATIENT_RESULT Group
Control1..1
Must Supporttrue
12. ORU_R01.PATIENT-RESULT.PATIENT
ShortPATIENT Group
Control1..1
Must Supporttrue
14. ORU_R01.PATIENT-RESULT.PATIENT.PID
ShortPatient Identification
Control1..1
TypePID
Must Supporttrue
16. ORU_R01.PATIENT-RESULT.PATIENT.PD1
ShortPatient Additional Demographic
Control0..1
TypePD1
18. ORU_R01.PATIENT-RESULT.PATIENT.PRT
ShortParticipation Information
Control0..*
TypePRT
20. ORU_R01.PATIENT-RESULT.PATIENT.OH1
ShortPerson Employment Status
Control0..*
TypeOH1
22. ORU_R01.PATIENT-RESULT.PATIENT.OH2
ShortPast or Present Job
Control0..*
TypeOH2
24. ORU_R01.PATIENT-RESULT.PATIENT.OH3
ShortUsual Work
Control0..1
TypeOH3
26. ORU_R01.PATIENT-RESULT.PATIENT.OH4
ShortCombat Zone Work
Control0..*
TypeOH4
28. ORU_R01.PATIENT-RESULT.PATIENT.NTE
ShortNotes and Comments
Control0..*
TypeNTE
30. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN
ShortNEXT_OF_KIN Group
Control1..1
Must Supporttrue
32. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.NK1
ShortNext of Kin / Associated Parties
Control1..1
TypeNK1
Must Supporttrue
34. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.OH2
ShortPast or Present Job
Control0..*
TypeOH2
36. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.OH3
ShortUsual Work
Control0..1
TypeOH3
38. ORU_R01.PATIENT-RESULT.PATIENT.ARV
ShortAccess Restriction
Control0..*
TypeARV
40. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION
ShortPATIENT_OBSERVATION Group
Control1..1
Must Supporttrue
42. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
44. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
46. ORU_R01.PATIENT-RESULT.PATIENT.VISIT
ShortVISIT Group
Control1..1
Must Supporttrue
48. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PV1
ShortPatient Visit
Control1..1
TypePV1
Must Supporttrue
50. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PV2
ShortPatient Visit - Additional Information
Control0..1
TypePV2
52. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PRT
ShortParticipation Information
Control0..*
TypePRT
54. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE
ShortINSURANCE Group
Control1..1
Must Supporttrue
56. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN1
ShortInsurance
Control1..1
TypeIN1
Must Supporttrue
58. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN2
ShortInsurance Additional Information
Control0..1
TypeIN2
60. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN3
ShortInsurance Additional Information, Certification
Control0..1
TypeIN3
62. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION
ShortORDER_OBSERVATION Group
Control1..1
Must Supporttrue
64. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER
ShortCOMMON_ORDER Group
Control1..1
Must Supporttrue
66. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORC
ShortCommon Order
Control1..1
TypeORC
Must Supporttrue
68. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.PRT
ShortParticipation Information
Control0..*
TypePRT
70. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT
ShortORDER_DOCUMENT Group
Control1..1
Must Supporttrue
72. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
74. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.PRT
ShortParticipation Information
Control0..*
TypePRT
76. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.TXA
ShortTranscription Document Header
Control1..1
TypeTXA
Must Supporttrue
78. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBR
ShortObservation Request
Control1..1
TypeOBR
Must Supporttrue
80. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
82. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION
ShortOBSERVATION_PARTICIPATION Group
Control1..1
Must Supporttrue
84. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION.PRT
ShortParticipation Information
Control1..1
TypePRT
Must Supporttrue
86. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION.DEV
ShortDevice
Control0..*
TypeDEV
88. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY
ShortTIMING_QTY Group
Control1..1
Must Supporttrue
90. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY.TQ1
ShortTiming/Quantity
Control1..1
TypeTQ1
Must Supporttrue
92. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY.TQ2
ShortTiming/Quantity Relationship
Control0..*
TypeTQ2
94. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.CTD
ShortContact Data
Control0..1
TypeCTD
96. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION
ShortOBSERVATION Group
Control1..1
Must Supporttrue
98. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
100. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
102. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
104. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.FT1
ShortFinancial Transaction
Control0..*
TypeFT1
106. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.CTI
ShortClinical Trial Identification
Control0..*
TypeCTI
108. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN
ShortSPECIMEN Group
Control1..1
Must Supporttrue
110. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPM
ShortSpecimen
Control1..1
TypeSPM
Must Supporttrue
112. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION
ShortSPECIMEN_OBSERVATION Group
Control1..1
Must Supporttrue
114. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
116. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
118. ORU_R01.PATIENT-RESULT.DEVICE
ShortDEVICE Group
Control1..1
Must Supporttrue
120. ORU_R01.PATIENT-RESULT.DEVICE.DEV
ShortDevice
Control1..1
TypeDEV
Must Supporttrue
122. ORU_R01.PATIENT-RESULT.DEVICE.OBX
ShortObservation/Result
Control0..*
TypeOBX
124. ORU_R01.DSC
ShortContinuation Pointer
Control0..1
TypeDSC

Guidance on how to interpret the contents of this table can be found here

0. ORU_R01
Definition

Observation Message


A resource that includes narrative, extensions, and contained resources.

ShortA resource with narrative, extensions, and contained resources
Control10..1*
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ORU_R01.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ORU_R01.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. ORU_R01.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ORU_R01.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
8. ORU_R01.MSH
ShortMessage Header
Control1..1
TypeMSH
Must Supporttrue
10. ORU_R01.ARV
ShortAccess Restriction
Control0..*
TypeARV
12. ORU_R01.SFT
ShortSoftware Segment
Control0..*
TypeSFT
14. ORU_R01.UAC
ShortUser Authentication Credential Segment
Control0..1
TypeUAC
16. ORU_R01.PATIENT-RESULT
ShortPATIENT_RESULT Group
Control1..1
Must Supporttrue
18. ORU_R01.PATIENT-RESULT.PATIENT
ShortPATIENT Group
Control1..1
Must Supporttrue
20. ORU_R01.PATIENT-RESULT.PATIENT.PID
ShortPatient Identification
Control1..1
TypePID
Must Supporttrue
22. ORU_R01.PATIENT-RESULT.PATIENT.PD1
ShortPatient Additional Demographic
Control0..1
TypePD1
24. ORU_R01.PATIENT-RESULT.PATIENT.PRT
ShortParticipation Information
Control0..*
TypePRT
26. ORU_R01.PATIENT-RESULT.PATIENT.OH1
ShortPerson Employment Status
Control0..*
TypeOH1
28. ORU_R01.PATIENT-RESULT.PATIENT.OH2
ShortPast or Present Job
Control0..*
TypeOH2
30. ORU_R01.PATIENT-RESULT.PATIENT.OH3
ShortUsual Work
Control0..1
TypeOH3
32. ORU_R01.PATIENT-RESULT.PATIENT.OH4
ShortCombat Zone Work
Control0..*
TypeOH4
34. ORU_R01.PATIENT-RESULT.PATIENT.NTE
ShortNotes and Comments
Control0..*
TypeNTE
36. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN
ShortNEXT_OF_KIN Group
Control1..1
Must Supporttrue
38. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.NK1
ShortNext of Kin / Associated Parties
Control1..1
TypeNK1
Must Supporttrue
40. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.OH2
ShortPast or Present Job
Control0..*
TypeOH2
42. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.OH3
ShortUsual Work
Control0..1
TypeOH3
44. ORU_R01.PATIENT-RESULT.PATIENT.ARV
ShortAccess Restriction
Control0..*
TypeARV
46. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION
ShortPATIENT_OBSERVATION Group
Control1..1
Must Supporttrue
48. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
50. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
52. ORU_R01.PATIENT-RESULT.PATIENT.VISIT
ShortVISIT Group
Control1..1
Must Supporttrue
54. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PV1
ShortPatient Visit
Control1..1
TypePV1
Must Supporttrue
56. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PV2
ShortPatient Visit - Additional Information
Control0..1
TypePV2
58. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PRT
ShortParticipation Information
Control0..*
TypePRT
60. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE
ShortINSURANCE Group
Control1..1
Must Supporttrue
62. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN1
ShortInsurance
Control1..1
TypeIN1
Must Supporttrue
64. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN2
ShortInsurance Additional Information
Control0..1
TypeIN2
66. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN3
ShortInsurance Additional Information, Certification
Control0..1
TypeIN3
68. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION
ShortORDER_OBSERVATION Group
Control1..1
Must Supporttrue
70. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER
ShortCOMMON_ORDER Group
Control1..1
Must Supporttrue
72. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORC
ShortCommon Order
Control1..1
TypeORC
Must Supporttrue
74. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.PRT
ShortParticipation Information
Control0..*
TypePRT
76. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT
ShortORDER_DOCUMENT Group
Control1..1
Must Supporttrue
78. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
80. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.PRT
ShortParticipation Information
Control0..*
TypePRT
82. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.TXA
ShortTranscription Document Header
Control1..1
TypeTXA
Must Supporttrue
84. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBR
ShortObservation Request
Control1..1
TypeOBR
Must Supporttrue
86. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
88. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION
ShortOBSERVATION_PARTICIPATION Group
Control1..1
Must Supporttrue
90. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION.PRT
ShortParticipation Information
Control1..1
TypePRT
Must Supporttrue
92. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION.DEV
ShortDevice
Control0..*
TypeDEV
94. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY
ShortTIMING_QTY Group
Control1..1
Must Supporttrue
96. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY.TQ1
ShortTiming/Quantity
Control1..1
TypeTQ1
Must Supporttrue
98. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY.TQ2
ShortTiming/Quantity Relationship
Control0..*
TypeTQ2
100. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.CTD
ShortContact Data
Control0..1
TypeCTD
102. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION
ShortOBSERVATION Group
Control1..1
Must Supporttrue
104. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
106. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
108. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
110. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.FT1
ShortFinancial Transaction
Control0..*
TypeFT1
112. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.CTI
ShortClinical Trial Identification
Control0..*
TypeCTI
114. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN
ShortSPECIMEN Group
Control1..1
Must Supporttrue
116. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPM
ShortSpecimen
Control1..1
TypeSPM
Must Supporttrue
118. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION
ShortSPECIMEN_OBSERVATION Group
Control1..1
Must Supporttrue
120. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
122. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
124. ORU_R01.PATIENT-RESULT.DEVICE
ShortDEVICE Group
Control1..1
Must Supporttrue
126. ORU_R01.PATIENT-RESULT.DEVICE.DEV
ShortDevice
Control1..1
TypeDEV
Must Supporttrue
128. ORU_R01.PATIENT-RESULT.DEVICE.OBX
ShortObservation/Result
Control0..*
TypeOBX
130. ORU_R01.DSC
ShortContinuation Pointer
Control0..1
TypeDSC

Guidance on how to interpret the contents of this table can be found here

0. ORU_R01
Definition

Observation Message

ShortA resource with narrative, extensions, and contained resources
Control1..1
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ORU_R01.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. ORU_R01.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ORU_R01.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ORU_R01.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages: IETF language tag for a human language
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ORU_R01.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ORU_R01.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. ORU_R01.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ORU_R01.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. ORU_R01.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ORU_R01.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. ORU_R01.MSH
ShortMessage Header
Control1..1
TypeMSH
Must Supporttrue
20. ORU_R01.ARV
ShortAccess Restriction
Control0..*
TypeARV
22. ORU_R01.SFT
ShortSoftware Segment
Control0..*
TypeSFT
24. ORU_R01.UAC
ShortUser Authentication Credential Segment
Control0..1
TypeUAC
26. ORU_R01.PATIENT-RESULT
ShortPATIENT_RESULT Group
Control1..1
Must Supporttrue
28. ORU_R01.PATIENT-RESULT.PATIENT
ShortPATIENT Group
Control1..1
Must Supporttrue
30. ORU_R01.PATIENT-RESULT.PATIENT.PID
ShortPatient Identification
Control1..1
TypePID
Must Supporttrue
32. ORU_R01.PATIENT-RESULT.PATIENT.PD1
ShortPatient Additional Demographic
Control0..1
TypePD1
34. ORU_R01.PATIENT-RESULT.PATIENT.PRT
ShortParticipation Information
Control0..*
TypePRT
36. ORU_R01.PATIENT-RESULT.PATIENT.OH1
ShortPerson Employment Status
Control0..*
TypeOH1
38. ORU_R01.PATIENT-RESULT.PATIENT.OH2
ShortPast or Present Job
Control0..*
TypeOH2
40. ORU_R01.PATIENT-RESULT.PATIENT.OH3
ShortUsual Work
Control0..1
TypeOH3
42. ORU_R01.PATIENT-RESULT.PATIENT.OH4
ShortCombat Zone Work
Control0..*
TypeOH4
44. ORU_R01.PATIENT-RESULT.PATIENT.NTE
ShortNotes and Comments
Control0..*
TypeNTE
46. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN
ShortNEXT_OF_KIN Group
Control1..1
Must Supporttrue
48. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.NK1
ShortNext of Kin / Associated Parties
Control1..1
TypeNK1
Must Supporttrue
50. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.OH2
ShortPast or Present Job
Control0..*
TypeOH2
52. ORU_R01.PATIENT-RESULT.PATIENT.NEXT-OF-KIN.OH3
ShortUsual Work
Control0..1
TypeOH3
54. ORU_R01.PATIENT-RESULT.PATIENT.ARV
ShortAccess Restriction
Control0..*
TypeARV
56. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION
ShortPATIENT_OBSERVATION Group
Control1..1
Must Supporttrue
58. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
60. ORU_R01.PATIENT-RESULT.PATIENT.PATIENT-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
62. ORU_R01.PATIENT-RESULT.PATIENT.VISIT
ShortVISIT Group
Control1..1
Must Supporttrue
64. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PV1
ShortPatient Visit
Control1..1
TypePV1
Must Supporttrue
66. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PV2
ShortPatient Visit - Additional Information
Control0..1
TypePV2
68. ORU_R01.PATIENT-RESULT.PATIENT.VISIT.PRT
ShortParticipation Information
Control0..*
TypePRT
70. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE
ShortINSURANCE Group
Control1..1
Must Supporttrue
72. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN1
ShortInsurance
Control1..1
TypeIN1
Must Supporttrue
74. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN2
ShortInsurance Additional Information
Control0..1
TypeIN2
76. ORU_R01.PATIENT-RESULT.PATIENT.INSURANCE.IN3
ShortInsurance Additional Information, Certification
Control0..1
TypeIN3
78. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION
ShortORDER_OBSERVATION Group
Control1..1
Must Supporttrue
80. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER
ShortCOMMON_ORDER Group
Control1..1
Must Supporttrue
82. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORC
ShortCommon Order
Control1..1
TypeORC
Must Supporttrue
84. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.PRT
ShortParticipation Information
Control0..*
TypePRT
86. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT
ShortORDER_DOCUMENT Group
Control1..1
Must Supporttrue
88. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
90. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.PRT
ShortParticipation Information
Control0..*
TypePRT
92. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.COMMON-ORDER.ORDER-DOCUMENT.TXA
ShortTranscription Document Header
Control1..1
TypeTXA
Must Supporttrue
94. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBR
ShortObservation Request
Control1..1
TypeOBR
Must Supporttrue
96. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
98. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION
ShortOBSERVATION_PARTICIPATION Group
Control1..1
Must Supporttrue
100. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION.PRT
ShortParticipation Information
Control1..1
TypePRT
Must Supporttrue
102. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION-PARTICIPATION.DEV
ShortDevice
Control0..*
TypeDEV
104. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY
ShortTIMING_QTY Group
Control1..1
Must Supporttrue
106. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY.TQ1
ShortTiming/Quantity
Control1..1
TypeTQ1
Must Supporttrue
108. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.TIMING-QTY.TQ2
ShortTiming/Quantity Relationship
Control0..*
TypeTQ2
110. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.CTD
ShortContact Data
Control0..1
TypeCTD
112. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION
ShortOBSERVATION Group
Control1..1
Must Supporttrue
114. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
116. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
118. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
120. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.FT1
ShortFinancial Transaction
Control0..*
TypeFT1
122. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.CTI
ShortClinical Trial Identification
Control0..*
TypeCTI
124. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN
ShortSPECIMEN Group
Control1..1
Must Supporttrue
126. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPM
ShortSpecimen
Control1..1
TypeSPM
Must Supporttrue
128. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION
ShortSPECIMEN_OBSERVATION Group
Control1..1
Must Supporttrue
130. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
132. ORU_R01.PATIENT-RESULT.ORDER-OBSERVATION.SPECIMEN.SPECIMEN-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
134. ORU_R01.PATIENT-RESULT.DEVICE
ShortDEVICE Group
Control1..1
Must Supporttrue
136. ORU_R01.PATIENT-RESULT.DEVICE.DEV
ShortDevice
Control1..1
TypeDEV
Must Supporttrue
138. ORU_R01.PATIENT-RESULT.DEVICE.OBX
ShortObservation/Result
Control0..*
TypeOBX
140. ORU_R01.DSC
ShortContinuation Pointer
Control0..1
TypeDSC