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

Draft as of 2023-08-09

Definitions for the OBR logical model.

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

0. OBR
Definition

Observation Request

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. OBR.setID-OBR
Definition

Set ID - OBR

ShortsetID-OBR
Control0..1
TypeSI
Max Length4
4. OBR.placerOrderNumber
Definition

Placer Order Number

ShortplacerOrderNumber
Control0..1
TypeEI
6. OBR.fillerOrderNumber
Definition

Filler Order Number

ShortfillerOrderNumber
Control0..1
TypeEI
8. OBR.universalServiceIdentifier
Definition

Universal Service Identifier

ShortuniversalServiceIdentifier
Control1..1
TypeCWE
Must Supporttrue
10. OBR.priority
Definition

Priority

Shortpriority
Control0..1
Type-
12. OBR.requestedDateTime
Definition

Requested DateTime

ShortrequestedDateTime
Control0..1
Type-
14. OBR.observationDateTime
Definition

Observation DateTime #

ShortobservationDateTime
Control0..1
TypeDTM
16. OBR.observationEndDateTime
Definition

Observation End DateTime #

ShortobservationEndDateTime
Control0..1
TypeDTM
18. OBR.collectionVolume
Definition

**Collection Volume ***

ShortcollectionVolume
Control0..1
TypeCQ
20. OBR.collectorIdentifier
Definition

**Collector Identifier ***

ShortcollectorIdentifier
Control0..*
TypeXCN
22. OBR.specimenActionCode
Definition

**Specimen Action Code ***

ShortspecimenActionCode
Control0..1
TypeID
Max Length1
24. OBR.dangerCode
Definition

Danger Code

ShortdangerCode
Control0..1
TypeCWE
26. OBR.relevantClinicalInformation
Definition

Relevant Clinical Information

ShortrelevantClinicalInformation
Control0..*
TypeCWE
28. OBR.specimenReceivedDateTime
Definition

Specimen Received DateTime

ShortspecimenReceivedDateTime
Control0..1
TypeDTM
30. OBR.specimenSource
Definition

Specimen Source

ShortspecimenSource
Control0..1
Type-
32. OBR.orderingProvider
Definition

Ordering Provider

ShortorderingProvider
Control0..1
Type-
34. OBR.orderCallbackPhoneNumber
Definition

Order Callback Phone Number

ShortorderCallbackPhoneNumber
Control0..*
TypeXTN
36. OBR.placerField1
Definition

Placer Field 1

ShortplacerField1
Control0..1
TypeST
38. OBR.placerField2
Definition

Placer Field 2

ShortplacerField2
Control0..1
TypeST
40. OBR.fillerField1+
Definition

Filler Field 1 +

ShortfillerField1+
Control0..1
TypeST
42. OBR.fillerField2+
Definition

Filler Field 2 +

ShortfillerField2+
Control0..1
TypeST
44. OBR.resultsRptStatusChng-DateTime+
Definition

Results RptStatus Chng - DateTime +

ShortresultsRptStatusChng-DateTime+
Control0..1
TypeDTM
46. OBR.chargetoPractice+
Definition

Charge to Practice +

ShortchargetoPractice+
Control0..1
TypeMOC
48. OBR.diagnosticServSectID
Definition

Diagnostic Serv Sect ID

ShortdiagnosticServSectID
Control0..1
TypeID
Max Length3
50. OBR.resultStatus+
Definition

Result Status +

ShortresultStatus+
Control0..1
TypeID
Max Length1
52. OBR.parentResult+
Definition

Parent Result +

ShortparentResult+
Control0..1
TypePRL
54. OBR.quantityTiming
Definition

QuantityTiming

ShortquantityTiming
Control0..*
Type-
56. OBR.resultCopiesTo
Definition

Result Copies To

ShortresultCopiesTo
Control0..1
Type-
58. OBR.parentResultsObservationIdentifier
Definition

Parent Results Observation Identifier

ShortparentResultsObservationIdentifier
Control0..1
TypeEIP
60. OBR.transportationMode
Definition

Transportation Mode

ShorttransportationMode
Control0..1
TypeID
Max Length4
62. OBR.reasonforStudy
Definition

Reason for Study

ShortreasonforStudy
Control0..*
TypeCWE
64. OBR.principalResultInterpreter+
Definition

Principal Result Interpreter +

ShortprincipalResultInterpreter+
Control0..1
Type-
66. OBR.assistantResultInterpreter+
Definition

Assistant Result Interpreter +

ShortassistantResultInterpreter+
Control0..1
Type-
68. OBR.technician+
Definition

Technician +

Shorttechnician+
Control0..1
Type-
70. OBR.transcriptionist+
Definition

Transcriptionist +

Shorttranscriptionist+
Control0..1
Type-
72. OBR.scheduledDateTime+
Definition

Scheduled DateTime +

ShortscheduledDateTime+
Control0..1
TypeDTM
74. OBR.numberofSampleContainers
Definition

**Number of Sample Containers ***

ShortnumberofSampleContainers
Control0..1
TypeNM
76. OBR.transportLogisticsofCollectedSample
Definition

**Transport Logistics of Collected Sample ***

ShorttransportLogisticsofCollectedSample
Control0..*
TypeCWE
78. OBR.collectorsComment
Definition

**Collector's Comment ***

ShortcollectorsComment
Control0..*
TypeCWE
80. OBR.transportArrangementResponsibility
Definition

Transport Arrangement Responsibility

ShorttransportArrangementResponsibility
Control0..1
TypeCWE
82. OBR.transportArranged
Definition

Transport Arranged

ShorttransportArranged
Control0..1
TypeID
Max Length1
84. OBR.escortRequired
Definition

Escort Required

ShortescortRequired
Control0..1
TypeID
Max Length1
86. OBR.plannedPatientTransportComment
Definition

Planned Patient Transport Comment

ShortplannedPatientTransportComment
Control0..*
TypeCWE
88. OBR.procedureCode
Definition

Procedure Code

ShortprocedureCode
Control0..1
TypeCNE
90. OBR.procedureCodeModifier
Definition

Procedure Code Modifier

ShortprocedureCodeModifier
Control0..*
TypeCNE
92. OBR.placerSupplementalServiceInformation
Definition

Placer Supplemental Service Information

ShortplacerSupplementalServiceInformation
Control0..*
TypeCWE
94. OBR.fillerSupplementalServiceInformation
Definition

Filler Supplemental Service Information

ShortfillerSupplementalServiceInformation
Control0..*
TypeCWE
96. OBR.medicallyNecessaryDuplicateProcedureReason
Definition

Medically Necessary Duplicate Procedure Reason

ShortmedicallyNecessaryDuplicateProcedureReason
Control0..1
TypeCWE
98. OBR.resultHandling
Definition

Result Handling

ShortresultHandling
Control0..1
TypeCWE
100. OBR.parentUniversalServiceIdentifier
Definition

Parent Universal Service Identifier

ShortparentUniversalServiceIdentifier
Control0..1
Type-
102. OBR.observationGroupID
Definition

Observation Group ID

ShortobservationGroupID
Control0..1
TypeEI
104. OBR.parentObservationGroupID
Definition

Parent Observation Group ID

ShortparentObservationGroupID
Control0..1
TypeEI
106. OBR.alternatePlacerOrderNumber
Definition

Alternate Placer Order Number

ShortalternatePlacerOrderNumber
Control0..*
TypeCX
108. OBR.parentOrder
Definition

Parent Order

ShortparentOrder
Control0..*
TypeEIP
110. OBR.actionCode
Definition

Action Code

ShortactionCode
Control0..1
TypeID
Max Length2

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

0. OBR
Definition

Observation Request


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. OBR.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. OBR.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. OBR.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 OBR.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. OBR.setID-OBR
Definition

Set ID - OBR

ShortsetID-OBR
Control0..1
TypeSI
Max Length4
10. OBR.placerOrderNumber
Definition

Placer Order Number

ShortplacerOrderNumber
Control0..1
TypeEI
12. OBR.fillerOrderNumber
Definition

Filler Order Number

ShortfillerOrderNumber
Control0..1
TypeEI
14. OBR.universalServiceIdentifier
Definition

Universal Service Identifier

ShortuniversalServiceIdentifier
Control1..1
TypeCWE
Must Supporttrue
16. OBR.priority
Definition

Priority

Shortpriority
Control0..1
Type-
18. OBR.requestedDateTime
Definition

Requested DateTime

ShortrequestedDateTime
Control0..1
Type-
20. OBR.observationDateTime
Definition

Observation DateTime #

ShortobservationDateTime
Control0..1
TypeDTM
22. OBR.observationEndDateTime
Definition

Observation End DateTime #

ShortobservationEndDateTime
Control0..1
TypeDTM
24. OBR.collectionVolume
Definition

**Collection Volume ***

ShortcollectionVolume
Control0..1
TypeCQ
26. OBR.collectorIdentifier
Definition

**Collector Identifier ***

ShortcollectorIdentifier
Control0..*
TypeXCN
28. OBR.specimenActionCode
Definition

**Specimen Action Code ***

ShortspecimenActionCode
Control0..1
TypeID
Max Length1
30. OBR.dangerCode
Definition

Danger Code

ShortdangerCode
Control0..1
TypeCWE
32. OBR.relevantClinicalInformation
Definition

Relevant Clinical Information

ShortrelevantClinicalInformation
Control0..*
TypeCWE
34. OBR.specimenReceivedDateTime
Definition

Specimen Received DateTime

ShortspecimenReceivedDateTime
Control0..1
TypeDTM
36. OBR.specimenSource
Definition

Specimen Source

ShortspecimenSource
Control0..1
Type-
38. OBR.orderingProvider
Definition

Ordering Provider

ShortorderingProvider
Control0..1
Type-
40. OBR.orderCallbackPhoneNumber
Definition

Order Callback Phone Number

ShortorderCallbackPhoneNumber
Control0..*
TypeXTN
42. OBR.placerField1
Definition

Placer Field 1

ShortplacerField1
Control0..1
TypeST
44. OBR.placerField2
Definition

Placer Field 2

ShortplacerField2
Control0..1
TypeST
46. OBR.fillerField1+
Definition

Filler Field 1 +

ShortfillerField1+
Control0..1
TypeST
48. OBR.fillerField2+
Definition

Filler Field 2 +

ShortfillerField2+
Control0..1
TypeST
50. OBR.resultsRptStatusChng-DateTime+
Definition

Results RptStatus Chng - DateTime +

ShortresultsRptStatusChng-DateTime+
Control0..1
TypeDTM
52. OBR.chargetoPractice+
Definition

Charge to Practice +

ShortchargetoPractice+
Control0..1
TypeMOC
54. OBR.diagnosticServSectID
Definition

Diagnostic Serv Sect ID

ShortdiagnosticServSectID
Control0..1
TypeID
Max Length3
56. OBR.resultStatus+
Definition

Result Status +

ShortresultStatus+
Control0..1
TypeID
Max Length1
58. OBR.parentResult+
Definition

Parent Result +

ShortparentResult+
Control0..1
TypePRL
60. OBR.quantityTiming
Definition

QuantityTiming

ShortquantityTiming
Control0..*
Type-
62. OBR.resultCopiesTo
Definition

Result Copies To

ShortresultCopiesTo
Control0..1
Type-
64. OBR.parentResultsObservationIdentifier
Definition

Parent Results Observation Identifier

ShortparentResultsObservationIdentifier
Control0..1
TypeEIP
66. OBR.transportationMode
Definition

Transportation Mode

ShorttransportationMode
Control0..1
TypeID
Max Length4
68. OBR.reasonforStudy
Definition

Reason for Study

ShortreasonforStudy
Control0..*
TypeCWE
70. OBR.principalResultInterpreter+
Definition

Principal Result Interpreter +

ShortprincipalResultInterpreter+
Control0..1
Type-
72. OBR.assistantResultInterpreter+
Definition

Assistant Result Interpreter +

ShortassistantResultInterpreter+
Control0..1
Type-
74. OBR.technician+
Definition

Technician +

Shorttechnician+
Control0..1
Type-
76. OBR.transcriptionist+
Definition

Transcriptionist +

Shorttranscriptionist+
Control0..1
Type-
78. OBR.scheduledDateTime+
Definition

Scheduled DateTime +

ShortscheduledDateTime+
Control0..1
TypeDTM
80. OBR.numberofSampleContainers
Definition

**Number of Sample Containers ***

ShortnumberofSampleContainers
Control0..1
TypeNM
82. OBR.transportLogisticsofCollectedSample
Definition

**Transport Logistics of Collected Sample ***

ShorttransportLogisticsofCollectedSample
Control0..*
TypeCWE
84. OBR.collectorsComment
Definition

**Collector's Comment ***

ShortcollectorsComment
Control0..*
TypeCWE
86. OBR.transportArrangementResponsibility
Definition

Transport Arrangement Responsibility

ShorttransportArrangementResponsibility
Control0..1
TypeCWE
88. OBR.transportArranged
Definition

Transport Arranged

ShorttransportArranged
Control0..1
TypeID
Max Length1
90. OBR.escortRequired
Definition

Escort Required

ShortescortRequired
Control0..1
TypeID
Max Length1
92. OBR.plannedPatientTransportComment
Definition

Planned Patient Transport Comment

ShortplannedPatientTransportComment
Control0..*
TypeCWE
94. OBR.procedureCode
Definition

Procedure Code

ShortprocedureCode
Control0..1
TypeCNE
96. OBR.procedureCodeModifier
Definition

Procedure Code Modifier

ShortprocedureCodeModifier
Control0..*
TypeCNE
98. OBR.placerSupplementalServiceInformation
Definition

Placer Supplemental Service Information

ShortplacerSupplementalServiceInformation
Control0..*
TypeCWE
100. OBR.fillerSupplementalServiceInformation
Definition

Filler Supplemental Service Information

ShortfillerSupplementalServiceInformation
Control0..*
TypeCWE
102. OBR.medicallyNecessaryDuplicateProcedureReason
Definition

Medically Necessary Duplicate Procedure Reason

ShortmedicallyNecessaryDuplicateProcedureReason
Control0..1
TypeCWE
104. OBR.resultHandling
Definition

Result Handling

ShortresultHandling
Control0..1
TypeCWE
106. OBR.parentUniversalServiceIdentifier
Definition

Parent Universal Service Identifier

ShortparentUniversalServiceIdentifier
Control0..1
Type-
108. OBR.observationGroupID
Definition

Observation Group ID

ShortobservationGroupID
Control0..1
TypeEI
110. OBR.parentObservationGroupID
Definition

Parent Observation Group ID

ShortparentObservationGroupID
Control0..1
TypeEI
112. OBR.alternatePlacerOrderNumber
Definition

Alternate Placer Order Number

ShortalternatePlacerOrderNumber
Control0..*
TypeCX
114. OBR.parentOrder
Definition

Parent Order

ShortparentOrder
Control0..*
TypeEIP
116. OBR.actionCode
Definition

Action Code

ShortactionCode
Control0..1
TypeID
Max Length2

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

0. OBR
Definition

Observation Request

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. OBR.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. OBR.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. OBR.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. OBR.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. OBR.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. OBR.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. OBR.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 OBR.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. OBR.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 OBR.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. OBR.setID-OBR
Definition

Set ID - OBR

ShortsetID-OBR
Control0..1
TypeSI
Max Length4
20. OBR.placerOrderNumber
Definition

Placer Order Number

ShortplacerOrderNumber
Control0..1
TypeEI
22. OBR.fillerOrderNumber
Definition

Filler Order Number

ShortfillerOrderNumber
Control0..1
TypeEI
24. OBR.universalServiceIdentifier
Definition

Universal Service Identifier

ShortuniversalServiceIdentifier
Control1..1
TypeCWE
Must Supporttrue
26. OBR.priority
Definition

Priority

Shortpriority
Control0..1
Type-
28. OBR.requestedDateTime
Definition

Requested DateTime

ShortrequestedDateTime
Control0..1
Type-
30. OBR.observationDateTime
Definition

Observation DateTime #

ShortobservationDateTime
Control0..1
TypeDTM
32. OBR.observationEndDateTime
Definition

Observation End DateTime #

ShortobservationEndDateTime
Control0..1
TypeDTM
34. OBR.collectionVolume
Definition

**Collection Volume ***

ShortcollectionVolume
Control0..1
TypeCQ
36. OBR.collectorIdentifier
Definition

**Collector Identifier ***

ShortcollectorIdentifier
Control0..*
TypeXCN
38. OBR.specimenActionCode
Definition

**Specimen Action Code ***

ShortspecimenActionCode
Control0..1
TypeID
Max Length1
40. OBR.dangerCode
Definition

Danger Code

ShortdangerCode
Control0..1
TypeCWE
42. OBR.relevantClinicalInformation
Definition

Relevant Clinical Information

ShortrelevantClinicalInformation
Control0..*
TypeCWE
44. OBR.specimenReceivedDateTime
Definition

Specimen Received DateTime

ShortspecimenReceivedDateTime
Control0..1
TypeDTM
46. OBR.specimenSource
Definition

Specimen Source

ShortspecimenSource
Control0..1
Type-
48. OBR.orderingProvider
Definition

Ordering Provider

ShortorderingProvider
Control0..1
Type-
50. OBR.orderCallbackPhoneNumber
Definition

Order Callback Phone Number

ShortorderCallbackPhoneNumber
Control0..*
TypeXTN
52. OBR.placerField1
Definition

Placer Field 1

ShortplacerField1
Control0..1
TypeST
54. OBR.placerField2
Definition

Placer Field 2

ShortplacerField2
Control0..1
TypeST
56. OBR.fillerField1+
Definition

Filler Field 1 +

ShortfillerField1+
Control0..1
TypeST
58. OBR.fillerField2+
Definition

Filler Field 2 +

ShortfillerField2+
Control0..1
TypeST
60. OBR.resultsRptStatusChng-DateTime+
Definition

Results RptStatus Chng - DateTime +

ShortresultsRptStatusChng-DateTime+
Control0..1
TypeDTM
62. OBR.chargetoPractice+
Definition

Charge to Practice +

ShortchargetoPractice+
Control0..1
TypeMOC
64. OBR.diagnosticServSectID
Definition

Diagnostic Serv Sect ID

ShortdiagnosticServSectID
Control0..1
TypeID
Max Length3
66. OBR.resultStatus+
Definition

Result Status +

ShortresultStatus+
Control0..1
TypeID
Max Length1
68. OBR.parentResult+
Definition

Parent Result +

ShortparentResult+
Control0..1
TypePRL
70. OBR.quantityTiming
Definition

QuantityTiming

ShortquantityTiming
Control0..*
Type-
72. OBR.resultCopiesTo
Definition

Result Copies To

ShortresultCopiesTo
Control0..1
Type-
74. OBR.parentResultsObservationIdentifier
Definition

Parent Results Observation Identifier

ShortparentResultsObservationIdentifier
Control0..1
TypeEIP
76. OBR.transportationMode
Definition

Transportation Mode

ShorttransportationMode
Control0..1
TypeID
Max Length4
78. OBR.reasonforStudy
Definition

Reason for Study

ShortreasonforStudy
Control0..*
TypeCWE
80. OBR.principalResultInterpreter+
Definition

Principal Result Interpreter +

ShortprincipalResultInterpreter+
Control0..1
Type-
82. OBR.assistantResultInterpreter+
Definition

Assistant Result Interpreter +

ShortassistantResultInterpreter+
Control0..1
Type-
84. OBR.technician+
Definition

Technician +

Shorttechnician+
Control0..1
Type-
86. OBR.transcriptionist+
Definition

Transcriptionist +

Shorttranscriptionist+
Control0..1
Type-
88. OBR.scheduledDateTime+
Definition

Scheduled DateTime +

ShortscheduledDateTime+
Control0..1
TypeDTM
90. OBR.numberofSampleContainers
Definition

**Number of Sample Containers ***

ShortnumberofSampleContainers
Control0..1
TypeNM
92. OBR.transportLogisticsofCollectedSample
Definition

**Transport Logistics of Collected Sample ***

ShorttransportLogisticsofCollectedSample
Control0..*
TypeCWE
94. OBR.collectorsComment
Definition

**Collector's Comment ***

ShortcollectorsComment
Control0..*
TypeCWE
96. OBR.transportArrangementResponsibility
Definition

Transport Arrangement Responsibility

ShorttransportArrangementResponsibility
Control0..1
TypeCWE
98. OBR.transportArranged
Definition

Transport Arranged

ShorttransportArranged
Control0..1
TypeID
Max Length1
100. OBR.escortRequired
Definition

Escort Required

ShortescortRequired
Control0..1
TypeID
Max Length1
102. OBR.plannedPatientTransportComment
Definition

Planned Patient Transport Comment

ShortplannedPatientTransportComment
Control0..*
TypeCWE
104. OBR.procedureCode
Definition

Procedure Code

ShortprocedureCode
Control0..1
TypeCNE
106. OBR.procedureCodeModifier
Definition

Procedure Code Modifier

ShortprocedureCodeModifier
Control0..*
TypeCNE
108. OBR.placerSupplementalServiceInformation
Definition

Placer Supplemental Service Information

ShortplacerSupplementalServiceInformation
Control0..*
TypeCWE
110. OBR.fillerSupplementalServiceInformation
Definition

Filler Supplemental Service Information

ShortfillerSupplementalServiceInformation
Control0..*
TypeCWE
112. OBR.medicallyNecessaryDuplicateProcedureReason
Definition

Medically Necessary Duplicate Procedure Reason

ShortmedicallyNecessaryDuplicateProcedureReason
Control0..1
TypeCWE
114. OBR.resultHandling
Definition

Result Handling

ShortresultHandling
Control0..1
TypeCWE
116. OBR.parentUniversalServiceIdentifier
Definition

Parent Universal Service Identifier

ShortparentUniversalServiceIdentifier
Control0..1
Type-
118. OBR.observationGroupID
Definition

Observation Group ID

ShortobservationGroupID
Control0..1
TypeEI
120. OBR.parentObservationGroupID
Definition

Parent Observation Group ID

ShortparentObservationGroupID
Control0..1
TypeEI
122. OBR.alternatePlacerOrderNumber
Definition

Alternate Placer Order Number

ShortalternatePlacerOrderNumber
Control0..*
TypeCX
124. OBR.parentOrder
Definition

Parent Order

ShortparentOrder
Control0..*
TypeEIP
126. OBR.actionCode
Definition

Action Code

ShortactionCode
Control0..1
TypeID
Max Length2