HL7 Version 2 to FHIR
1.0.0-ballot - ballot
HL7 Version 2 to FHIR
1.0.0-ballot - ballot
HL7 Version 2 to FHIR, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/v2-to-fhir/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/v2mappings/segment-obx-to-observation | Version: 1.0.0-ballot | |||
| Active as of 2024-03-22 | Computable Name: SegmentOBXToObservation | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
||||
This ConceptMap represents a mapping from the HL7 V2 Segment OBX to the FHIR Observation Resource.
This ConceptMap represents the mapping from the HL7 V2 OBX Segment to the FHIR Observation Resource. See also the FHIR Shorthand or the CSV Source.
| HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sort Order | Identifier | Name | Data Type | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | FHIR Attribute | Extension | Data Type | Cardinality - Min | Cardinality - Max | Data Type Mapping | Vocabulary Mapping (IS, ID, CE, CEN, CWE) | Assignment | |
| 1 | OBX-1 | Set ID – OBX | SI | 0 | 1 | ||||||||||||
| 2 | OBX-2 | Value Type | ID | 0 | 1 | ValueType | OBX-2 determines the flavor of Observation.value[x] is used in OBX-5. | ||||||||||
| 3 | OBX-3 | Observation Identifier | CWE | 1 | 1 | Observation.code | Observation.CodeableConcept | 1 | 1 | CWE[CodeableConcept] | Note that in Observation there is category field that depending on implementation guide and/or realm is required. MSH-9.2 Trigger Event, the MSH-3 Sending Application and OBX-3 Observation Identifier's code system ontology would inform how to value Observation.category. | ||||||
| 4 | OBX-4 | Observation Sub-ID | OG | 0 | 1 | Map to Observation.partOf or Observation.hasMember or Observation.DerivedFrom according to the implementation guidance for the v2 message at hand, otherwise map to the extension-sub-id to enable the final destination to determine how to structure the observations. | extension??-subId | OBX-4 Sub Identifier would determine how to use Observation.partOf or Observation.hasMember or Observation.DerivedFrom, but is highly dependent on the local implementation of OBX-4 or an implementation guide (e.g., LRI, Clinical Genomics). That is not known at the standard level, so we cannot provide specific mapping guidance here. However, if the mapper does not have access to the syntax used and its meaning, we need to be able to pass on OBX-4 Sub Identifier to the final destination that should know how to then structure it using FHIR attributes. | |||||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-5 LST.count GREATER THAN 1 | Note that when OBX-5 repeats, the standard mapping is to use Observation.component (see OBX[Observation-Component] map) rather than creating separate Observation instances. However, we are aware that some profiles and implementation guides do separate the OBX into multiple observations depending on the OBX-2 value. This is an example of a non-standard interpretation as the OBX should have been separated into multiple OBX segments to start. Please consider the local profiles and implementation guides on how to manage these variants. | ||||||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "NM" | Observation.valueQuantity.value | Observation.quantity | 0 | 1 | NM[Quantity] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 IN ("ST", "FT", "TX") | Any markup in ST, FT or TX data may not present properly given that valueString is a string data type | Observation.valueString | Observation.string | 0 | 1 | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "CF" | Observation.valueCodeableConcept | Observation.CodeableConcept | 0 | 1 | CF[CodeableConcept] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "CNE" | Observation.valueCodeableConcept | Observation.CodeableConcept | 0 | 1 | CNE[CodeableConcept] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "CE" | Observation.valueCodeableConcept | Observation.CodeableConcept | 0 | 1 | CE[CodeableConcept] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "CWE" | Observation.valueCodeableConcept | Observation.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "IS" | Observation.valueCodeableConcept | Observation.CodeableConcept | 0 | 1 | IS[CodeableConcept] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "DR" | Observation.valuePeriod | Observation.Period | 0 | 1 | DR[Period] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 IN ("DTM", "DT") | Observation.valueDateTime | Observation.dateTime | 0 | 1 | |||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "NR" | Observation.valueRange | Observation.Range | 0 | 1 | NR[Range] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "VR" | Observation.valueString | Observation.string | 0 | 1 | OBX-5.1+"-"+OBX-5.2 | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "TM" | Observation.valueTime | Observation.time | 0 | 1 | |||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF (OBX-2 EQUALS "SN" AND OBX-5.3 IN (":", "/") | Observation.valueRatio | Observation.Ratio | 0 | 1 | SN[Ratio] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "SN" and OBX-5.3 EQUALS "-" | Observation.valueRange | Observation.Range | 0 | 1 | SN[Range] | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "SN" and OBX-5.3 EQUALS "+" | Observation.valueString | Observation.string | 0 | 1 | OBX-5.1+" "+OBX-5.2+" "+OBX-5.3+" "+OBX-5.4 | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "SN" and OBX-5.3 NOT IN (":", "/", "-", "+") | Observation.valueQuantity | Observation.Quantity | 0 | 1 | SN[Quantity] | Note that OBX-5 and OBX-6 resolve to different components for the same Quantity data type. | |||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "NA" | Observation.valueSampledData | Observation.SampledData | Need to add text on converting NA to SampledData | ||||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "ED" AND IF OBX-5.4 EQUALS "Base64" | Observation.extension.url | Observation.uri | 1 | 1 | "https://hl7.org/fhir/R5/StructureDefinition/extension-Observation.valueAttachment | ||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "ED" AND IF OBX-5.4 EQUALS "Base64" | Observation.extension.valueAttachment | Observation.Attachment | 1 | 1 | ED[Attachment] | We are for now addressing Base64 that cover .pdf, pictures and other binaries. If somebody does this, we will address those. | |||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "EI" | Requires more work to properly map. Use case: An OBX under OBR that points to the calibration/quality control/etc. settings/values/result/etc. that the other OBX-s under the OBR would be "subject" to. | ||||||||||
| OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "RP" | Observation.extension.url | Observation.uri | 1 | 1 | "https://hl7.org/fhir/R5/StructureDefinition/extension-Observation.valueAttachment | |||||||
| 5 | OBX-5 | Observation Value | varies | 0 | -1 | IF OBX-2 EQUALS "RP" | Observation.extension.valueAttachment | Observation.Attachment | 1 | 1 | ED[Attachment] | To be resolved when we resolve DocumentReference and valueAttachment | |||||
| 6 | OBX-6 | Units | CWE | 0 | 1 | IF OBX-2 EQUALS "SN" and OBX-5.3 NOT IN (":", "/", "-", "+") | Observation.valueQuantity | Observation.Quantity | CWE[Quantity] | Note that OBX-5 and OBX-6 resolve to different components for the same Quantity data type. | |||||||
| 6 | OBX-6 | Units | CWE | 0 | 1 | IF OBX-2 IN ("NA", "NM") | Observation.valueQuantity | Observation.Quantity | CWE[Quantity] | Note that OBX-5 and OBX-6 resolve to different components for the same Quantity data type. | |||||||
| 6 | OBX-6 | Units | CWE | 0 | 1 | IF OBX-2 EQUALS "SN" AND OBX-5.3 EQUALS "-" | Observation.valueRange.low | Observation.SimpleQuantity | CWE[Quantity] | ||||||||
| 6 | OBX-6 | Units | CWE | 0 | 1 | IF OBX-2 EQUALS "SN" AND OBX-5.3 EQUALS "-" | Observation.valueRange.high | Observation.SimpleQuantity | CWE[Quantity] | ||||||||
| 6 | OBX-6 | Units | CWE | 0 | 1 | IF (OBX-2 EQUALS "SN" AND (OBX-5.3 IN (":", "/")) | Observation.valueRatio.numerator | Observation.Quantity | CWE[Quantity] | ||||||||
| 6 | OBX-6 | Units | CWE | 0 | 1 | IF (OBX-2 EQUALS "SN" AND (OBX-5.3 IN (":", "/")) | Observation.valueRatio.denominator | Observation.Quantity | CWE[Quantity] | ||||||||
| 7 | OBX-7 | References Range | ST | 0 | 1 | Observation.referenceRange.text | Observation.string | 0 | -1 | If OBX-7 is sufficiently parseable, then the low, high, type, appliesTo, and/or age may be used. | |||||||
| 8 | OBX-8 | Interpretation Codes | CWE | 0 | -1 | Observation.interpretation | Observation.CodeableConcept | 0 | -1 | CWE[CodeableConcept] | InterpretationCode | ||||||
| 9 | OBX-9 | Probability | NM | 0 | 1 | ||||||||||||
| 10 | OBX-10 | Nature of Abnormal Test | ID | 0 | -1 | Observation.extension.uri | Observation.uri | 0 | -1 | "http://hl7.org/fhir/StructureDefinition/observation-nature-of-abnormal-test" | |||||||
| 10 | OBX-10 | Nature of Abnormal Test | ID | 0 | -1 | Observation.extension.valueCodeableConcept | Observation.CodeableConcept | 0 | -1 | CWE[CodeableConcept] | NatureOfAbnormalTesting | ||||||
| 11 | OBX-11 | Observation Result Status | ID | 1 | 1 | Observation.status | Observation.code | 1 | 1 | ObservationStatus | |||||||
| 11 | OBX-11 | Observation Result Status | ID | 1 | 1 | IF OBX-11 IS "X" | Observation.dataAbsentReason.coding.code | Observation.CodeableConcept | /cannot-be-obtained/ | Needs to be requested | |||||||
| 11 | OBX-11 | Observation Result Status | ID | 1 | 1 | IF OBX-11 IS "X" | Observation.dataAbsentReason.coding.system | Observation.uri | "http://terminology.hl7.org/CodeSystem/data-absent-reason" | ||||||||
| 11 | OBX-11 | Observation Result Status | ID | 1 | 1 | IF OBX-11 IS "N" | Observation.dataAbsentReason.coding.code | "not-asked" | |||||||||
| 11 | OBX-11 | Observation Result Status | ID | 1 | 1 | IF OBX-11 IS "N" | Observation.dataAbsentReason.coding.system | "http://terminology.hl7.org/CodeSystem/data-absent-reason" | |||||||||
| 12 | OBX-12 | Effective Date of Reference Range | DTM | 0 | 1 | ||||||||||||
| 13 | OBX-13 | User Defined Access Checks | ST | 0 | 1 | ||||||||||||
| 14 | OBX-14 | Date/Time of the Observation | DTM | 0 | 1 | Observation.effectiveDateTime | Observation.dateTime | 0 | 1 | ||||||||
| 15 | OBX-15 | Producer's ID | CWE | 0 | 1 | Observation.performer(Observation.Organization) | Observation.identifier | 0 | 1 | CWE[Organization] | We are mapping this to an identifier considering the definition (used for a unique identifier of the producer), although that does not fit the use of the CWE data type in HL7 v2. Depending on context (e.g., US CLIA or IHE LTW, or ILW) this may reflect a location (US CLIA) or an organization (IHE LTW or ILW). | ||||||
| 15 | OBX-15 | Producer's ID | CWE | 0 | 1 | Observation.performer(Observation.PractitionerRole) | |||||||||||
| 16 | OBX-16 | Responsible Observer | XCN | 0 | -1 | Observation.performer(Observation.PractitionerRole.practitioner(Observation.Practitioner) | Reference(Observation.PractitionerRole) | 0 | -1 | XCN[Practitioner] | |||||||
| 16 | OBX-16 | Responsible Observer | XCN | 0 | -1 | Observation.performer(Observation.PractitionerRole.code.coding.code) | Observation.CodeableConcept | 0 | -1 | "responsibleObserver" | |||||||
| 16 | OBX-16 | Responsible Observer | XCN | 0 | -1 | Observation.performer(Observation.PractitionerRole.code.coding.system) | Observation.CodeableConcept | 0 | -1 | "http://terminology.hl7.org/CodeSystem/practitioner-role" | |||||||
| 17 | OBX-17 | Observation Method | CWE | 0 | -1 | Observation.method | Observation.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | The cardinality of Observation.method is 0..1 while the source allows for multiple methods. As we are not aware of anybody populating multiples in HL7 v2, we did not provide further mapping guidance. If you need to support multiples, please submit a gForge to OO for the HL7 v2 to FHIR mapping Implementation Guide. | ||||||
| 18 | OBX-18 | Equipment Instance Identifier | EI | 0 | -1 | Observation.device(Observation.Device.identifier) | Observation.Identifier | 0 | 1 | EI[Identifier-Extension] | |||||||
| 19 | OBX-19 | Date/Time of the Analysis | DTM | 0 | 1 | Observation.extension.url | Observation.uri | 0 | 1 | "http://hl7.org/fhir/StructureDefinition/observation-analysis-date-time" | |||||||
| 19 | OBX-19 | Date/Time of the Analysis | DTM | 0 | 1 | Observation.extension.valueDateTime | Observation.dateTime | 0 | 1 | ||||||||
| 20 | OBX-20 | Observation Site | CWE | 0 | -1 | Observation.bodySite | Observation.CodeableConcept | 0 | 1 | CWE[CodeableConcept] | The cardinality of Observation.bodySite is 0..1 while the source allows for multiple body sites. As we are not aware of anybody populating multiples in HL7 v2, we did not provide further mapping guidance. If you need to support multiples, please submit a gForge to OO for the HL7 v2 to FHIR mapping Implementation Guide. | ||||||
| 21 | OBX-21 | Observation Instance Identifier | EI | 0 | 1 | Observation.identifier | Observation.Identifier | 0 | -1 | EI[Identifier-Extension] | |||||||
| 21 | OBX-21 | Observation Instance Identifier | EI | 0 | 1 | Observation.identifier.type.coding.code | Observation.code | 0 | 1 | "FILL" | |||||||
| 22 | OBX-22 | Mood Code | CNE | 0 | 1 | ||||||||||||
| 23 | OBX-23 | Performing Organization Name | XON | 0 | 1 | IF OBX-25 NOT VALUED | Observation.performer(Observation.Organization) | Reference(Observation.Organization) | 0 | -1 | XON[Organization] | ||||||
| 23 | OBX-23 | Performing Organization Name | XON | 0 | 1 | IF OBX-25 VALUED | Observation.performer(Observation.PractitionerRole.organization(Observation.Organization) | Reference(Observation.Organization) | 0 | -1 | XON[Organization] | ||||||
| 24 | OBX-24 | Performing Organization Address | XAD | 0 | 1 | IF OBX-25 NOT VALUED | Observation.performer(Observation.Organization.address) | Observation.Address | 0 | -1 | XAD[Address] | ||||||
| 24 | OBX-24 | Performing Organization Address | XAD | 0 | 1 | IF OBX-25 VALUED | Observation.performer(Observation.PractitionerRole.organization(Observation.Organization.address) | Observation.Address | 0 | -1 | XAD[Address] | ||||||
| 25 | OBX-25 | Performing Organization Medical Director | XCN | 0 | 1 | Observation.performer(Observation.PractitionerRole.practitioner) | Reference(Observation.PractitionerRole) | 0 | 1 | XCN[PractitionerRole] | |||||||
| 25 | OBX-25 | Performing Organization Medical Director | XCN | 0 | 1 | Observation.performer(Observation.PractitionerRole.code.coding.code) | Observation.code | "MDIR" | |||||||||
| 25 | OBX-25 | Performing Organization Medical Director | XCN | 0 | 1 | Observation.performer(Observation.PractitionerRole.code.coding.system) | "http://terminology.hl7.org/CodeSystem/v2-0912" | ||||||||||
| 26 | OBX-26 | Patient Results Release Category | ID | 0 | 1 | ||||||||||||
| 27 | OBX-27 | Root Cause | CWE | 0 | 1 | ||||||||||||
| 28 | OBX-28 | Local Process Control | CWE | 0 | -1 | ||||||||||||
| 29 | OBX-29 | Observation Type | ID | 0 | 1 | ||||||||||||
| 30 | OBX-30 | Observation Sub-Type | ID | 0 | 1 | extension??-subType | Observation.code | 0 | 1 | The sub type was necessary in v2 to distinguish purpose of the observation when it appears in a message in the same group (e.g., answers to ask at order entry questions with actual results ). Within FHIR flagging the observation may not be necessary, but that is not yet clear. Until then, we will keep the thought of needing an extension, but not create it yet. | |||||||
| 31 | OBX-31 | Action Code | ID | 0 | 1 | ||||||||||||
| 32 | OBX-32 | Observation Value Absent Reason | CWE | 0 | -1 | ||||||||||||
| 33 | OBX-33 | Observation Related Specimen Identifier | EIP | 0 | -1 | IF OBX-33 COUNT>1 | Observation.extension.uri | Reference | 0 | 1 | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.specimen | Note that in v2 messages the observations that a calculated observation is derived from on and involve multiple specimens are typically not included with the message. To enable relating the calculated observation to the correct specimens it relates to, the v2 message should include the originating observations that in turn use OBX-33 to link to the correct specimens. Without that, and if there are multiple specimens in OBX-33, there is no standard method to correctly associate the observation with the correct specimens. The implementer will have to devise an appropriate method for that in their context. | |||||
| 33 | OBX-33 | Observation Related Specimen Identifier | EIP | 0 | -1 | IF OBX-33 COUNT>1 | Observation.extension.valueReference(Observation.Group.member.entity(Observation.Specimen.identifier) | 0 | 1 | ||||||||
| 33 | OBX-33 | Observation Related Specimen Identifier | EIP | 0 | -1 | IF OBX-33 COUNT>1 | Observation.extension.uri | 0 | 1 | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.specimen | |||||||
| 33 | OBX-33 | Observation Related Specimen Identifier | EIP | 0 | -1 | IF OBX-33 COUNT>1 | Observation.extension.valueReference(Observation.Group.member.entity(Observation.Specimen.identifier) | 0 | 1 | ||||||||
| 33 | OBX-33 | Observation Related Specimen Identifier | EIP | 0 | -1 | IF OBX-33 COUNT=1 | Observation.specimen(Observation.Specimen.identifier) | Observation.Identifier | EIP[Identifier-PlacerAssignedIdentifier] | ||||||||
| 33 | OBX-33 | Observation Related Specimen Identifier | EIP | 0 | -1 | IF OBX-33 COUNT=1 | Observation.specimen(Observation.Specimen.identifier) | Observation.Identifier | EIP[Identifier-FillerAssignedIdentifier] | ||||||||
Mapping from OBX to Observation
ACTIVE (not intended for production usage). Published on 2024-03-22 by HL7 International / Orders and Observations (HL7 Orders and Observations Workgroup: http://www.hl7.org/Special/com..., Keith W. Boone: kboone@ainq.com, Rob Hausam: rrhausam@gmail.com). Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.
This ConceptMap represents a mapping from the HL7 V2 Segment OBX to the FHIR Observation Resource.
Group 1 Mapping from unspecified code system to unspecified code system
| Source Concept Details | Relationship | Target Concept Details | Comment | Properties | ||||||||||
| Codes from | vocabularymap | datatypemap | value | Codes from | antlr | narrative | ||||||||
| OBX-3 | Observation Identifier | CWE[CodeableConcept] | is equivalent to | code | code | Note that in Observation there is category field that depending on implementation guide and/or realm is required. MSH-9.2 Trigger Event, the MSH-3 Sending Application and OBX-3 Observation Identifier's code system ontology would inform how to value Observation.category. | ||||||||
| OBX-5 | Observation Value | NM[Quantity] | is equivalent to | valueQuantity.value | valueQuantity.value | IF OBX-2 EQUALS "NM" | ||||||||
| OBX-5 | Observation Value | is equivalent to | valueString | valueString | IF OBX-2 IN ("ST", "FT", "TX") | Any markup in ST, FT or TX data may not present properly given that valueString is a string data type | ||||||||
| OBX-5 | Observation Value | CF[CodeableConcept] | is equivalent to | valueCodeableConcept | valueCodeableConcept | IF OBX-2 EQUALS "CF" | ||||||||
| OBX-5 | Observation Value | CNE[CodeableConcept] | is equivalent to | valueCodeableConcept | valueCodeableConcept | IF OBX-2 EQUALS "CNE" | ||||||||
| OBX-5 | Observation Value | CE[CodeableConcept] | is equivalent to | valueCodeableConcept | valueCodeableConcept | IF OBX-2 EQUALS "CE" | ||||||||
| OBX-5 | Observation Value | CWE[CodeableConcept] | is equivalent to | valueCodeableConcept | valueCodeableConcept | IF OBX-2 EQUALS "CWE" | ||||||||
| OBX-5 | Observation Value | IS[CodeableConcept] | is equivalent to | valueCodeableConcept | valueCodeableConcept | IF OBX-2 EQUALS "IS" | ||||||||
| OBX-5 | Observation Value | DR[Period] | is equivalent to | valuePeriod | valuePeriod | IF OBX-2 EQUALS "DR" | ||||||||
| OBX-5 | Observation Value | is equivalent to | valueDateTime | valueDateTime | IF OBX-2 IN ("DTM", "DT") | |||||||||
| OBX-5 | Observation Value | NR[Range] | is equivalent to | valueRange | valueRange | IF OBX-2 EQUALS "NR" | ||||||||
| OBX-5 | Observation Value | OBX-5.1+"-"+OBX-5.2 | is equivalent to | valueString | valueString | IF OBX-2 EQUALS "VR" | ||||||||
| OBX-5 | Observation Value | is equivalent to | valueTime | valueTime | IF OBX-2 EQUALS "TM" | |||||||||
| OBX-5 | Observation Value | SN[Ratio] | is equivalent to | valueRatio | valueRatio | IF (OBX-2 EQUALS "SN" AND OBX-5.3 IN (":", "/") | ||||||||
| OBX-5 | Observation Value | SN[Range] | is equivalent to | valueRange | valueRange | IF OBX-2 EQUALS "SN" and OBX-5.3 EQUALS "-" | ||||||||
| OBX-5 | Observation Value | OBX-5.1+" "+OBX-5.2+" "+OBX-5.3+" "+OBX-5.4 | is equivalent to | valueString | valueString | IF OBX-2 EQUALS "SN" and OBX-5.3 EQUALS "+" | ||||||||
| OBX-5 | Observation Value | SN[Quantity] | is equivalent to | valueQuantity | valueQuantity | IF OBX-2 EQUALS "SN" and OBX-5.3 NOT IN (":", "/", "-", "+") | Note that OBX-5 and OBX-6 resolve to different components for the same Quantity data type. | |||||||
| OBX-5 | Observation Value | is equivalent to | valueSampledData | valueSampledData | IF OBX-2 EQUALS "NA" | Need to add text on converting NA to SampledData | ||||||||
| OBX-5 | Observation Value | "https://hl7.org/fhir/R5/StructureDefinition/extension-Observation.valueAttachment | is equivalent to | extension[1].url | extension[1].url | IF OBX-2 EQUALS "ED" AND IF OBX-5.4 EQUALS "Base64" | ||||||||
| OBX-5 | Observation Value | ED[Attachment] | is equivalent to | extension[1].valueAttachment | extension[1].valueAttachment | IF OBX-2 EQUALS "ED" AND IF OBX-5.4 EQUALS "Base64" | We are for now addressing Base64 that cover .pdf, pictures and other binaries. If somebody does this, we will address those. | |||||||
| OBX-5 | Observation Value | "https://hl7.org/fhir/R5/StructureDefinition/extension-Observation.valueAttachment | is equivalent to | extension[1].url | extension[1].url | IF OBX-2 EQUALS "RP" | ||||||||
| OBX-5 | Observation Value | ED[Attachment] | is equivalent to | extension[1].valueAttachment | extension[1].valueAttachment | IF OBX-2 EQUALS "RP" | To be resolved when we resolve DocumentReference and valueAttachment | |||||||
| OBX-6 | Units | CWE[Quantity] | is equivalent to | valueQuantity | valueQuantity | IF OBX-2 EQUALS "SN" and OBX-5.3 NOT IN (":", "/", "-", "+") | Note that OBX-5 and OBX-6 resolve to different components for the same Quantity data type. | |||||||
| OBX-6 | Units | CWE[Quantity] | is equivalent to | valueQuantity | valueQuantity | IF OBX-2 IN ("NA", "NM") | Note that OBX-5 and OBX-6 resolve to different components for the same Quantity data type. | |||||||
| OBX-6 | Units | CWE[Quantity] | is equivalent to | valueRange.low | valueRange.low | IF OBX-2 EQUALS "SN" AND OBX-5.3 EQUALS "-" | ||||||||
| OBX-6 | Units | CWE[Quantity] | is equivalent to | valueRange.high | valueRange.high | IF OBX-2 EQUALS "SN" AND OBX-5.3 EQUALS "-" | ||||||||
| OBX-6 | Units | CWE[Quantity] | is equivalent to | valueRatio.numerator | valueRatio.numerator | IF (OBX-2 EQUALS "SN" AND (OBX-5.3 IN (":", "/")) | ||||||||
| OBX-6 | Units | CWE[Quantity] | is equivalent to | valueRatio.denominator | valueRatio.denominator | IF (OBX-2 EQUALS "SN" AND (OBX-5.3 IN (":", "/")) | ||||||||
| OBX-7 | References Range | is equivalent to | referenceRange.text | referenceRange.text | If OBX-7 is sufficiently parseable, then the low, high, type, appliesTo, and/or age may be used. | |||||||||
| OBX-8 | Interpretation Codes | InterpretationCode | CWE[CodeableConcept] | is equivalent to | interpretation | interpretation | ||||||||
| OBX-10 | Nature of Abnormal Test | "http://hl7.org/fhir/StructureDefinition/observation-nature-of-abnormal-test" | is equivalent to | extension[2].uri | extension[2].uri | |||||||||
| OBX-10 | Nature of Abnormal Test | NatureOfAbnormalTesting | CWE[CodeableConcept] | is equivalent to | extension[2].valueCodeableConcept | extension[2].valueCodeableConcept | ||||||||
| OBX-11 | Observation Result Status | ObservationStatus | is equivalent to | status | status | |||||||||
| OBX-11 | Observation Result Status | /cannot-be-obtained/ | is equivalent to | dataAbsentReason.coding[1].code | dataAbsentReason.coding[1].code | IF OBX-11 IS "X" | Needs to be requested | |||||||
| OBX-11 | Observation Result Status | "http://terminology.hl7.org/CodeSystem/data-absent-reason" | is equivalent to | dataAbsentReason.coding[1].system | dataAbsentReason.coding[1].system | IF OBX-11 IS "X" | ||||||||
| OBX-11 | Observation Result Status | "not-asked" | is equivalent to | dataAbsentReason.coding[2].code | dataAbsentReason.coding[2].code | IF OBX-11 IS "N" | ||||||||
| OBX-11 | Observation Result Status | "http://terminology.hl7.org/CodeSystem/data-absent-reason" | is equivalent to | dataAbsentReason.coding[2].system | dataAbsentReason.coding[2].system | IF OBX-11 IS "N" | ||||||||
| OBX-14 | Date/Time of the Observation | is equivalent to | effectiveDateTime | effectiveDateTime | ||||||||||
| OBX-15 | Producer's ID | CWE[Organization] | is equivalent to | performer[2](Organization) | performer[2](Organization) | We are mapping this to an identifier considering the definition (used for a unique identifier of the producer), although that does not fit the use of the CWE data type in HL7 v2. Depending on context (e.g., US CLIA or IHE LTW, or ILW) this may reflect a location (US CLIA) or an organization (IHE LTW or ILW). | ||||||||
| OBX-15 | Producer's ID | is equivalent to | performer[2](PractitionerRole) | performer[2](PractitionerRole) | ||||||||||
| OBX-16 | Responsible Observer | XCN[Practitioner] | is equivalent to | performer[1](PractitionerRole.practitioner(Practitioner)) | performer[1](PractitionerRole.practitioner(Practitioner)) | |||||||||
| OBX-16 | Responsible Observer | "responsibleObserver" | is equivalent to | performer[1](PractitionerRole.code.coding.code) | performer[1](PractitionerRole.code.coding.code) | |||||||||
| OBX-16 | Responsible Observer | "http://terminology.hl7.org/CodeSystem/practitioner-role" | is equivalent to | performer[1](PractitionerRole.code.coding.system) | performer[1](PractitionerRole.code.coding.system) | |||||||||
| OBX-17 | Observation Method | CWE[CodeableConcept] | is equivalent to | method | method | The cardinality of Observation.method is 0..1 while the source allows for multiple methods. As we are not aware of anybody populating multiples in HL7 v2, we did not provide further mapping guidance. If you need to support multiples, please submit a gForge to OO for the HL7 v2 to FHIR mapping Implementation Guide. | ||||||||
| OBX-18 | Equipment Instance Identifier | EI[Identifier-Extension] | is equivalent to | device(Device.identifier) | device(Device.identifier) | |||||||||
| OBX-19 | Date/Time of the Analysis | is equivalent to | extension[2].url | extension[2].url | "http://hl7.org/fhir/StructureDefinition/observation-analysis-date-time" | |||||||||
| OBX-19 | Date/Time of the Analysis | is equivalent to | extension[2].valueDateTime | extension[2].valueDateTime | ||||||||||
| OBX-20 | Observation Site | CWE[CodeableConcept] | is equivalent to | bodySite | bodySite | The cardinality of Observation.bodySite is 0..1 while the source allows for multiple body sites. As we are not aware of anybody populating multiples in HL7 v2, we did not provide further mapping guidance. If you need to support multiples, please submit a gForge to OO for the HL7 v2 to FHIR mapping Implementation Guide. | ||||||||
| OBX-21 | Observation Instance Identifier | EI[Identifier-Extension] | is equivalent to | identifier | identifier | |||||||||
| OBX-21 | Observation Instance Identifier | "FILL" | is equivalent to | identifier.type.coding.code | identifier.type.coding.code | |||||||||
| OBX-23 | Performing Organization Name | XON[Organization] | is equivalent to | performer[2](Organization) | performer[2](Organization) | IF OBX-25 NOT VALUED | ||||||||
| OBX-23 | Performing Organization Name | XON[Organization] | is equivalent to | performer[2](PractitionerRole[1].organization(Organization)) | performer[2](PractitionerRole[1].organization(Organization)) | IF OBX-25 VALUED | ||||||||
| OBX-24 | Performing Organization Address | XAD[Address] | is equivalent to | performer[2](Organization.address) | performer[2](Organization.address) | IF OBX-25 NOT VALUED | ||||||||
| OBX-24 | Performing Organization Address | XAD[Address] | is equivalent to | performer[2](PractitionerRole[1].organization(Organization.address)) | performer[2](PractitionerRole[1].organization(Organization.address)) | IF OBX-25 VALUED | ||||||||
| OBX-25 | Performing Organization Medical Director | XCN[PractitionerRole] | is equivalent to | performer[2](PractitionerRole[1].practitioner) | performer[2](PractitionerRole[1].practitioner) | |||||||||
| OBX-25 | Performing Organization Medical Director | "MDIR" | is equivalent to | performer[2](PractitionerRole[1].code.coding.code) | performer[2](PractitionerRole[1].code.coding.code) | |||||||||
| OBX-25 | Performing Organization Medical Director | "http://terminology.hl7.org/CodeSystem/v2-0912" | is equivalent to | performer[2](PractitionerRole[1].code.coding.system) | performer[2](PractitionerRole[1].code.coding.system) | |||||||||
| OBX-33 | Observation Related Specimen Identifier | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.specimen | is equivalent to | extension[1].uri | extension[1].uri | IF OBX-33 COUNT>1 | Note that in v2 messages the observations that a calculated observation is derived from on and involve multiple specimens are typically not included with the message. To enable relating the calculated observation to the correct specimens it relates to, the v2 message should include the originating observations that in turn use OBX-33 to link to the correct specimens. Without that, and if there are multiple specimens in OBX-33, there is no standard method to correctly associate the observation with the correct specimens. The implementer will have to devise an appropriate method for that in their context. | |||||||
| OBX-33 | Observation Related Specimen Identifier | is equivalent to | extension[1].valueReference(Group.member.entity(Specimen.identifier[1]) | extension[1].valueReference(Group.member.entity(Specimen.identifier[1]) | IF OBX-33 COUNT>1 | |||||||||
| OBX-33 | Observation Related Specimen Identifier | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.specimen | is equivalent to | extension[2].uri | extension[2].uri | IF OBX-33 COUNT>1 | ||||||||
| OBX-33 | Observation Related Specimen Identifier | is equivalent to | extension[2].valueReference(Group.member.entity(Specimen.identifier[2])) | extension[2].valueReference(Group.member.entity(Specimen.identifier[2])) | IF OBX-33 COUNT>1 | |||||||||
| OBX-33 | Observation Related Specimen Identifier | EIP[Identifier-PlacerAssignedIdentifier] | is equivalent to | specimen(Specimen.identifier[1]) | specimen(Specimen.identifier[1]) | IF OBX-33 COUNT=1 | ||||||||
| OBX-33 | Observation Related Specimen Identifier | EIP[Identifier-FillerAssignedIdentifier] | is equivalent to | specimen(Specimen.identifier[2]) | specimen(Specimen.identifier[2]) | IF OBX-33 COUNT=1 | ||||||||
IG © 2020+ HL7 International / Orders and Observations. Package hl7.fhir.uv.v2mappings#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change