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: OML_O39 - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the OMLO39 logical model.

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

0. OML_O39
Definition

Specimen Shipment Centric Laboratory Order Message

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. OML_O39.MSH
ShortMessage Header
Control1..1
TypeMSH
Must Supporttrue
4. OML_O39.ARV
ShortAccess Restriction
Control0..*
TypeARV
6. OML_O39.SFT
ShortSoftware Segment
Control0..*
TypeSFT
8. OML_O39.UAC
ShortUser Authentication Credential Segment
Control0..1
TypeUAC
10. OML_O39.NTE
ShortNotes and Comments
Control0..*
TypeNTE
12. OML_O39.PATIENT
ShortPATIENT Group
Control1..1
Must Supporttrue
14. OML_O39.PATIENT.PID
ShortPatient Identification
Control1..1
TypePID
Must Supporttrue
16. OML_O39.PATIENT.PD1
ShortPatient Additional Demographic
Control0..1
TypePD1
18. OML_O39.PATIENT.PRT
ShortParticipation Information
Control0..*
TypePRT
20. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH
ShortOCCUPATIONAL_DATA_FOR_HEALTH Group
Control1..1
Must Supporttrue
22. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH1
ShortPerson Employment Status
Control0..*
TypeOH1
24. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH2
ShortPast or Present Job
Control0..*
TypeOH2
26. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH3
ShortUsual Work
Control0..1
TypeOH3
28. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH4
ShortCombat Zone Work
Control0..*
TypeOH4
30. OML_O39.PATIENT.NTE
ShortNotes and Comments
Control0..*
TypeNTE
32. OML_O39.PATIENT.NEXT-OF-KIN
ShortNEXT_OF_KIN Group
Control1..1
Must Supporttrue
34. OML_O39.PATIENT.NEXT-OF-KIN.NK1
ShortNext of Kin / Associated Parties
Control1..1
TypeNK1
Must Supporttrue
36. OML_O39.PATIENT.NEXT-OF-KIN.OH2
ShortPast or Present Job
Control0..*
TypeOH2
38. OML_O39.PATIENT.NEXT-OF-KIN.OH3
ShortUsual Work
Control0..1
TypeOH3
40. OML_O39.PATIENT.ARV
ShortAccess Restriction
Control0..*
TypeARV
42. OML_O39.PATIENT.PATIENT-VISIT
ShortPATIENT_VISIT Group
Control1..1
Must Supporttrue
44. OML_O39.PATIENT.PATIENT-VISIT.PV1
ShortPatient Visit
Control1..1
TypePV1
Must Supporttrue
46. OML_O39.PATIENT.PATIENT-VISIT.PV2
ShortPatient Visit - Additional Information
Control0..1
TypePV2
48. OML_O39.PATIENT.PATIENT-VISIT.PRT
ShortParticipation Information
Control0..*
TypePRT
50. OML_O39.PATIENT.INSURANCE
ShortINSURANCE Group
Control1..1
Must Supporttrue
52. OML_O39.PATIENT.INSURANCE.IN1
ShortInsurance
Control1..1
TypeIN1
Must Supporttrue
54. OML_O39.PATIENT.INSURANCE.IN2
ShortInsurance Additional Information
Control0..1
TypeIN2
56. OML_O39.PATIENT.INSURANCE.IN3
ShortInsurance Additional Information, Certification
Control0..1
TypeIN3
58. OML_O39.PATIENT.GT1
ShortGuarantor
Control0..1
TypeGT1
60. OML_O39.PATIENT.AL1
ShortPatient Allergy Information
Control0..*
TypeAL1
62. OML_O39.ORDER
ShortORDER Group
Control1..1
Must Supporttrue
64. OML_O39.ORDER.ORC
ShortCommon Order
Control1..1
TypeORC
Must Supporttrue
66. OML_O39.ORDER.NTE
ShortNotes and Comments
Control0..*
TypeNTE
68. OML_O39.ORDER.PRT
ShortParticipation Information
Control0..*
TypePRT
70. OML_O39.ORDER.TIMING
ShortTIMING Group
Control1..1
Must Supporttrue
72. OML_O39.ORDER.TIMING.TQ1
ShortTiming/Quantity
Control1..1
TypeTQ1
Must Supporttrue
74. OML_O39.ORDER.TIMING.TQ2
ShortTiming/Quantity Relationship
Control0..*
TypeTQ2
76. OML_O39.ORDER.OBSERVATION-REQUEST
ShortOBSERVATION_REQUEST Group
Control1..1
Must Supporttrue
78. OML_O39.ORDER.OBSERVATION-REQUEST.OBR
ShortObservation Request
Control1..1
TypeOBR
Must Supporttrue
80. OML_O39.ORDER.OBSERVATION-REQUEST.TCD
ShortTest Code Detail
Control0..1
TypeTCD
82. OML_O39.ORDER.OBSERVATION-REQUEST.NTE
ShortNotes and Comments
Control0..*
TypeNTE
84. OML_O39.ORDER.OBSERVATION-REQUEST.PRT
ShortParticipation Information
Control0..*
TypePRT
86. OML_O39.ORDER.OBSERVATION-REQUEST.CTD
ShortContact Data
Control0..1
TypeCTD
88. OML_O39.ORDER.OBSERVATION-REQUEST.DG1
ShortDiagnosis
Control0..*
TypeDG1
90. OML_O39.ORDER.OBSERVATION-REQUEST.REL
ShortClinical Relationship Segment
Control0..1
TypeREL
92. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION
ShortOBSERVATION Group
Control1..1
Must Supporttrue
94. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
96. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
98. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.TCD
ShortTest Code Detail
Control0..1
TypeTCD
100. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
102. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT
ShortSPECIMEN_SHIPMENT Group
Control1..1
Must Supporttrue
104. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHP
ShortShipment
Control1..1
TypeSHP
Must Supporttrue
106. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION
ShortSHIPMENT_OBSERVATION Group
Control1..1
Must Supporttrue
108. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
110. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
112. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE
ShortPACKAGE Group
Control1..1
Must Supporttrue
114. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.PAC
ShortShipment Package
Control1..1
TypePAC
Must Supporttrue
116. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE
ShortSPECIMEN_IN_PACKAGE Group
Control1..1
Must Supporttrue
118. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPM
ShortSpecimen
Control1..1
TypeSPM
Must Supporttrue
120. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.NTE
ShortNotes and Comments
Control0..*
TypeNTE
122. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION
ShortSPECIMEN_OBSERVATION Group
Control1..1
Must Supporttrue
124. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
126. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
128. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE
ShortSPECIMEN_CONTAINER_IN_PACKAGE Group
Control1..1
Must Supporttrue
130. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.SAC
ShortSpecimen Container detail
Control1..1
TypeSAC
Must Supporttrue
132. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.NTE
ShortNotes and Comments
Control0..*
TypeNTE
134. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION
ShortCONTAINER_OBSERVATION Group
Control1..1
Must Supporttrue
136. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
138. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
140. OML_O39.ORDER.FT1
ShortFinancial Transaction
Control0..*
TypeFT1
142. OML_O39.ORDER.CTI
ShortClinical Trial Identification
Control0..*
TypeCTI
144. OML_O39.ORDER.BLG
ShortBilling
Control0..1
TypeBLG
146. OML_O39.DEVICE
ShortDEVICE Group
Control1..1
Must Supporttrue
148. OML_O39.DEVICE.DEV
ShortDevice
Control1..1
TypeDEV
Must Supporttrue
150. OML_O39.DEVICE.OBX
ShortObservation/Result
Control0..*
TypeOBX

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

0. OML_O39
Definition

Specimen Shipment Centric Laboratory Order 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. OML_O39.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. OML_O39.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. OML_O39.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 OML_O39.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. OML_O39.MSH
ShortMessage Header
Control1..1
TypeMSH
Must Supporttrue
10. OML_O39.ARV
ShortAccess Restriction
Control0..*
TypeARV
12. OML_O39.SFT
ShortSoftware Segment
Control0..*
TypeSFT
14. OML_O39.UAC
ShortUser Authentication Credential Segment
Control0..1
TypeUAC
16. OML_O39.NTE
ShortNotes and Comments
Control0..*
TypeNTE
18. OML_O39.PATIENT
ShortPATIENT Group
Control1..1
Must Supporttrue
20. OML_O39.PATIENT.PID
ShortPatient Identification
Control1..1
TypePID
Must Supporttrue
22. OML_O39.PATIENT.PD1
ShortPatient Additional Demographic
Control0..1
TypePD1
24. OML_O39.PATIENT.PRT
ShortParticipation Information
Control0..*
TypePRT
26. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH
ShortOCCUPATIONAL_DATA_FOR_HEALTH Group
Control1..1
Must Supporttrue
28. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH1
ShortPerson Employment Status
Control0..*
TypeOH1
30. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH2
ShortPast or Present Job
Control0..*
TypeOH2
32. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH3
ShortUsual Work
Control0..1
TypeOH3
34. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH4
ShortCombat Zone Work
Control0..*
TypeOH4
36. OML_O39.PATIENT.NTE
ShortNotes and Comments
Control0..*
TypeNTE
38. OML_O39.PATIENT.NEXT-OF-KIN
ShortNEXT_OF_KIN Group
Control1..1
Must Supporttrue
40. OML_O39.PATIENT.NEXT-OF-KIN.NK1
ShortNext of Kin / Associated Parties
Control1..1
TypeNK1
Must Supporttrue
42. OML_O39.PATIENT.NEXT-OF-KIN.OH2
ShortPast or Present Job
Control0..*
TypeOH2
44. OML_O39.PATIENT.NEXT-OF-KIN.OH3
ShortUsual Work
Control0..1
TypeOH3
46. OML_O39.PATIENT.ARV
ShortAccess Restriction
Control0..*
TypeARV
48. OML_O39.PATIENT.PATIENT-VISIT
ShortPATIENT_VISIT Group
Control1..1
Must Supporttrue
50. OML_O39.PATIENT.PATIENT-VISIT.PV1
ShortPatient Visit
Control1..1
TypePV1
Must Supporttrue
52. OML_O39.PATIENT.PATIENT-VISIT.PV2
ShortPatient Visit - Additional Information
Control0..1
TypePV2
54. OML_O39.PATIENT.PATIENT-VISIT.PRT
ShortParticipation Information
Control0..*
TypePRT
56. OML_O39.PATIENT.INSURANCE
ShortINSURANCE Group
Control1..1
Must Supporttrue
58. OML_O39.PATIENT.INSURANCE.IN1
ShortInsurance
Control1..1
TypeIN1
Must Supporttrue
60. OML_O39.PATIENT.INSURANCE.IN2
ShortInsurance Additional Information
Control0..1
TypeIN2
62. OML_O39.PATIENT.INSURANCE.IN3
ShortInsurance Additional Information, Certification
Control0..1
TypeIN3
64. OML_O39.PATIENT.GT1
ShortGuarantor
Control0..1
TypeGT1
66. OML_O39.PATIENT.AL1
ShortPatient Allergy Information
Control0..*
TypeAL1
68. OML_O39.ORDER
ShortORDER Group
Control1..1
Must Supporttrue
70. OML_O39.ORDER.ORC
ShortCommon Order
Control1..1
TypeORC
Must Supporttrue
72. OML_O39.ORDER.NTE
ShortNotes and Comments
Control0..*
TypeNTE
74. OML_O39.ORDER.PRT
ShortParticipation Information
Control0..*
TypePRT
76. OML_O39.ORDER.TIMING
ShortTIMING Group
Control1..1
Must Supporttrue
78. OML_O39.ORDER.TIMING.TQ1
ShortTiming/Quantity
Control1..1
TypeTQ1
Must Supporttrue
80. OML_O39.ORDER.TIMING.TQ2
ShortTiming/Quantity Relationship
Control0..*
TypeTQ2
82. OML_O39.ORDER.OBSERVATION-REQUEST
ShortOBSERVATION_REQUEST Group
Control1..1
Must Supporttrue
84. OML_O39.ORDER.OBSERVATION-REQUEST.OBR
ShortObservation Request
Control1..1
TypeOBR
Must Supporttrue
86. OML_O39.ORDER.OBSERVATION-REQUEST.TCD
ShortTest Code Detail
Control0..1
TypeTCD
88. OML_O39.ORDER.OBSERVATION-REQUEST.NTE
ShortNotes and Comments
Control0..*
TypeNTE
90. OML_O39.ORDER.OBSERVATION-REQUEST.PRT
ShortParticipation Information
Control0..*
TypePRT
92. OML_O39.ORDER.OBSERVATION-REQUEST.CTD
ShortContact Data
Control0..1
TypeCTD
94. OML_O39.ORDER.OBSERVATION-REQUEST.DG1
ShortDiagnosis
Control0..*
TypeDG1
96. OML_O39.ORDER.OBSERVATION-REQUEST.REL
ShortClinical Relationship Segment
Control0..1
TypeREL
98. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION
ShortOBSERVATION Group
Control1..1
Must Supporttrue
100. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
102. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
104. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.TCD
ShortTest Code Detail
Control0..1
TypeTCD
106. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
108. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT
ShortSPECIMEN_SHIPMENT Group
Control1..1
Must Supporttrue
110. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHP
ShortShipment
Control1..1
TypeSHP
Must Supporttrue
112. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION
ShortSHIPMENT_OBSERVATION Group
Control1..1
Must Supporttrue
114. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
116. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
118. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE
ShortPACKAGE Group
Control1..1
Must Supporttrue
120. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.PAC
ShortShipment Package
Control1..1
TypePAC
Must Supporttrue
122. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE
ShortSPECIMEN_IN_PACKAGE Group
Control1..1
Must Supporttrue
124. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPM
ShortSpecimen
Control1..1
TypeSPM
Must Supporttrue
126. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.NTE
ShortNotes and Comments
Control0..*
TypeNTE
128. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION
ShortSPECIMEN_OBSERVATION Group
Control1..1
Must Supporttrue
130. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
132. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
134. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE
ShortSPECIMEN_CONTAINER_IN_PACKAGE Group
Control1..1
Must Supporttrue
136. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.SAC
ShortSpecimen Container detail
Control1..1
TypeSAC
Must Supporttrue
138. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.NTE
ShortNotes and Comments
Control0..*
TypeNTE
140. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION
ShortCONTAINER_OBSERVATION Group
Control1..1
Must Supporttrue
142. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
144. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
146. OML_O39.ORDER.FT1
ShortFinancial Transaction
Control0..*
TypeFT1
148. OML_O39.ORDER.CTI
ShortClinical Trial Identification
Control0..*
TypeCTI
150. OML_O39.ORDER.BLG
ShortBilling
Control0..1
TypeBLG
152. OML_O39.DEVICE
ShortDEVICE Group
Control1..1
Must Supporttrue
154. OML_O39.DEVICE.DEV
ShortDevice
Control1..1
TypeDEV
Must Supporttrue
156. OML_O39.DEVICE.OBX
ShortObservation/Result
Control0..*
TypeOBX

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

0. OML_O39
Definition

Specimen Shipment Centric Laboratory Order 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. OML_O39.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. OML_O39.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. OML_O39.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. OML_O39.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. OML_O39.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. OML_O39.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. OML_O39.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 OML_O39.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. OML_O39.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 OML_O39.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. OML_O39.MSH
ShortMessage Header
Control1..1
TypeMSH
Must Supporttrue
20. OML_O39.ARV
ShortAccess Restriction
Control0..*
TypeARV
22. OML_O39.SFT
ShortSoftware Segment
Control0..*
TypeSFT
24. OML_O39.UAC
ShortUser Authentication Credential Segment
Control0..1
TypeUAC
26. OML_O39.NTE
ShortNotes and Comments
Control0..*
TypeNTE
28. OML_O39.PATIENT
ShortPATIENT Group
Control1..1
Must Supporttrue
30. OML_O39.PATIENT.PID
ShortPatient Identification
Control1..1
TypePID
Must Supporttrue
32. OML_O39.PATIENT.PD1
ShortPatient Additional Demographic
Control0..1
TypePD1
34. OML_O39.PATIENT.PRT
ShortParticipation Information
Control0..*
TypePRT
36. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH
ShortOCCUPATIONAL_DATA_FOR_HEALTH Group
Control1..1
Must Supporttrue
38. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH1
ShortPerson Employment Status
Control0..*
TypeOH1
40. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH2
ShortPast or Present Job
Control0..*
TypeOH2
42. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH3
ShortUsual Work
Control0..1
TypeOH3
44. OML_O39.PATIENT.OCCUPATIONAL-DATA-FOR-HEALTH.OH4
ShortCombat Zone Work
Control0..*
TypeOH4
46. OML_O39.PATIENT.NTE
ShortNotes and Comments
Control0..*
TypeNTE
48. OML_O39.PATIENT.NEXT-OF-KIN
ShortNEXT_OF_KIN Group
Control1..1
Must Supporttrue
50. OML_O39.PATIENT.NEXT-OF-KIN.NK1
ShortNext of Kin / Associated Parties
Control1..1
TypeNK1
Must Supporttrue
52. OML_O39.PATIENT.NEXT-OF-KIN.OH2
ShortPast or Present Job
Control0..*
TypeOH2
54. OML_O39.PATIENT.NEXT-OF-KIN.OH3
ShortUsual Work
Control0..1
TypeOH3
56. OML_O39.PATIENT.ARV
ShortAccess Restriction
Control0..*
TypeARV
58. OML_O39.PATIENT.PATIENT-VISIT
ShortPATIENT_VISIT Group
Control1..1
Must Supporttrue
60. OML_O39.PATIENT.PATIENT-VISIT.PV1
ShortPatient Visit
Control1..1
TypePV1
Must Supporttrue
62. OML_O39.PATIENT.PATIENT-VISIT.PV2
ShortPatient Visit - Additional Information
Control0..1
TypePV2
64. OML_O39.PATIENT.PATIENT-VISIT.PRT
ShortParticipation Information
Control0..*
TypePRT
66. OML_O39.PATIENT.INSURANCE
ShortINSURANCE Group
Control1..1
Must Supporttrue
68. OML_O39.PATIENT.INSURANCE.IN1
ShortInsurance
Control1..1
TypeIN1
Must Supporttrue
70. OML_O39.PATIENT.INSURANCE.IN2
ShortInsurance Additional Information
Control0..1
TypeIN2
72. OML_O39.PATIENT.INSURANCE.IN3
ShortInsurance Additional Information, Certification
Control0..1
TypeIN3
74. OML_O39.PATIENT.GT1
ShortGuarantor
Control0..1
TypeGT1
76. OML_O39.PATIENT.AL1
ShortPatient Allergy Information
Control0..*
TypeAL1
78. OML_O39.ORDER
ShortORDER Group
Control1..1
Must Supporttrue
80. OML_O39.ORDER.ORC
ShortCommon Order
Control1..1
TypeORC
Must Supporttrue
82. OML_O39.ORDER.NTE
ShortNotes and Comments
Control0..*
TypeNTE
84. OML_O39.ORDER.PRT
ShortParticipation Information
Control0..*
TypePRT
86. OML_O39.ORDER.TIMING
ShortTIMING Group
Control1..1
Must Supporttrue
88. OML_O39.ORDER.TIMING.TQ1
ShortTiming/Quantity
Control1..1
TypeTQ1
Must Supporttrue
90. OML_O39.ORDER.TIMING.TQ2
ShortTiming/Quantity Relationship
Control0..*
TypeTQ2
92. OML_O39.ORDER.OBSERVATION-REQUEST
ShortOBSERVATION_REQUEST Group
Control1..1
Must Supporttrue
94. OML_O39.ORDER.OBSERVATION-REQUEST.OBR
ShortObservation Request
Control1..1
TypeOBR
Must Supporttrue
96. OML_O39.ORDER.OBSERVATION-REQUEST.TCD
ShortTest Code Detail
Control0..1
TypeTCD
98. OML_O39.ORDER.OBSERVATION-REQUEST.NTE
ShortNotes and Comments
Control0..*
TypeNTE
100. OML_O39.ORDER.OBSERVATION-REQUEST.PRT
ShortParticipation Information
Control0..*
TypePRT
102. OML_O39.ORDER.OBSERVATION-REQUEST.CTD
ShortContact Data
Control0..1
TypeCTD
104. OML_O39.ORDER.OBSERVATION-REQUEST.DG1
ShortDiagnosis
Control0..*
TypeDG1
106. OML_O39.ORDER.OBSERVATION-REQUEST.REL
ShortClinical Relationship Segment
Control0..1
TypeREL
108. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION
ShortOBSERVATION Group
Control1..1
Must Supporttrue
110. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
112. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
114. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.TCD
ShortTest Code Detail
Control0..1
TypeTCD
116. OML_O39.ORDER.OBSERVATION-REQUEST.OBSERVATION.NTE
ShortNotes and Comments
Control0..*
TypeNTE
118. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT
ShortSPECIMEN_SHIPMENT Group
Control1..1
Must Supporttrue
120. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHP
ShortShipment
Control1..1
TypeSHP
Must Supporttrue
122. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION
ShortSHIPMENT_OBSERVATION Group
Control1..1
Must Supporttrue
124. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
126. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.SHIPMENT-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
128. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE
ShortPACKAGE Group
Control1..1
Must Supporttrue
130. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.PAC
ShortShipment Package
Control1..1
TypePAC
Must Supporttrue
132. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE
ShortSPECIMEN_IN_PACKAGE Group
Control1..1
Must Supporttrue
134. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPM
ShortSpecimen
Control1..1
TypeSPM
Must Supporttrue
136. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.NTE
ShortNotes and Comments
Control0..*
TypeNTE
138. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION
ShortSPECIMEN_OBSERVATION Group
Control1..1
Must Supporttrue
140. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
142. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
144. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE
ShortSPECIMEN_CONTAINER_IN_PACKAGE Group
Control1..1
Must Supporttrue
146. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.SAC
ShortSpecimen Container detail
Control1..1
TypeSAC
Must Supporttrue
148. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.NTE
ShortNotes and Comments
Control0..*
TypeNTE
150. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION
ShortCONTAINER_OBSERVATION Group
Control1..1
Must Supporttrue
152. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION.OBX
ShortObservation/Result
Control1..1
TypeOBX
Must Supporttrue
154. OML_O39.ORDER.OBSERVATION-REQUEST.SPECIMEN-SHIPMENT.PACKAGE.SPECIMEN-IN-PACKAGE.SPECIMEN-CONTAINER-IN-PACKAGE.CONTAINER-OBSERVATION.PRT
ShortParticipation Information
Control0..*
TypePRT
156. OML_O39.ORDER.FT1
ShortFinancial Transaction
Control0..*
TypeFT1
158. OML_O39.ORDER.CTI
ShortClinical Trial Identification
Control0..*
TypeCTI
160. OML_O39.ORDER.BLG
ShortBilling
Control0..1
TypeBLG
162. OML_O39.DEVICE
ShortDEVICE Group
Control1..1
Must Supporttrue
164. OML_O39.DEVICE.DEV
ShortDevice
Control1..1
TypeDEV
Must Supporttrue
166. OML_O39.DEVICE.OBX
ShortObservation/Result
Control0..*
TypeOBX