This page is part of the HL7 Version 2 to FHIR (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/uv/v2mappings/message-oru-r01-to-bundle | Version: 1.0.0-ballot | |||
Active as of 2023-12-19 | Computable Name: MessageORU_R01ToBundle | |||
Copyright/Legal: Copyright (c) 2020, HL7 International, Inc., All Rights Reserved. |
This ConceptMap represents a mapping from the HL7 V2 Message ORU_R01 to the FHIR Message Bundle.
This ConceptMap represents the mapping from the HL7 V2 ORU_R01 Message to the FHIR Message Bundle. See also the FHIR Shorthand or the CSV Source.
HL7 v2 | Condition (IF True, args) | HL7 FHIR | Comments | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort Order | Identifier | Syntax | Name | Cardinality - Min | Cardinality - Max | Computable ANTLR | Computable FHIRPath | Narrative | Primary Target | Segment Map | References | </thead>|
1 | ORU_R01.MSH | MSH | Message Header | 1 | 1 | Bundle | MSH[Bundle] | |||||
1 | ORU_R01.MSH | MSH | Message Header | 1 | 1 | MessageHeader | MSH[MessageHeader] | Processing of the MSH segment results in the creation of a new MessageHeader resource | ||||
1 | ORU_R01.MSH | MSH | Message Header | 1 | 1 | If there is a source in MSH-4, or known based on the configuration. | Provenance | MSH[Provenance-Source] | Provenance[1].target.reference=Bundle.id; Provenance[1].target.reference=MessageHeader[1].id | If the FHIR transformation does not yield a FHIR message, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Provenance resource instance to the relevant FHIR resources generated. | ||
1 | ORU_R01.MSH | MSH | Message Header | 1 | 1 | Provenance | MSH[Provenance-Transformation] | Provenance[2].target.reference=Bundle.id | If the FHIR transformation does not yield a FHIR Bunlde, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Provenance resource instance to the relevant FHIR resources generated. | |||
2 | ORU_R01.SFT | [{ SFT }] | Software Segment | 0 | -1 | If the software does represent not the original source system | Provenance.entity.what(Device) | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="derivation" | |||
2 | ORU_R01.SFT | [{ SFT }] | Software Segment | 0 | -1 | If the software represents the original source system | Provenance.entity.what(Device) | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="source" | |||
3 | ORU_R01.UAC | [UAC] | User Authentication Credential | 0 | 1 | |||||||
4 | ORU_R01.PATIENT_RESULT | { | --- PATIENT_RESULT begin | 1 | -1 | |||||||
4.1 | ORU_R01.PATIENT_RESULT.PATIENT | [ | --- PATIENT begin | 0 | 1 | |||||||
4.1.1 | ORU_R01.PATIENT_RESULT.PATIENT.PID | PID | Patient Identification | 1 | 1 | Patient | PID[Patient] | Processing of the PID segment results in the creation of a new Patient resource | ||||
b | ORU_R01.PATIENT_RESULT.PATIENT.PID | PID | Patient Identification | 1 | 1 | IF PID-33 AND PID-34 VALUED | One may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date. | Provenance | PID[Provenance-Patient] | Provenance.target.reference=Patient[1].id | ||
4.1.2 | ORU_R01.PATIENT_RESULT.PATIENT.PD1 | [PD1] | Additional Demographics | 0 | 1 | Patient | PD1[Patient] | Incorporate PD1 content into the Patient created from the PID segment. | ||||
4.1.3 | ORU_R01.PATIENT_RESULT.PATIENT.PRT | [{PRT}] | Participation (for Patient) | 0 | -1 | IF PRT-4.1 EQUALS "PP" AND PRT-4.3 EQUALS "HL70443" | (PRT.element(4.1)="PP")and(PRT.element(4.3)="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | Patient[1].generalPractitioner.reference=PractitionerRole[1].id | Incorporate PRT content into the Patient created from the PID segment when the PRT contains practitioner related data. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. |
4.1.3 | ORU_R01.PATIENT_RESULT.PATIENT.PRT | [{PRT}] | Participation (for Patient) | 0 | -1 | IF PRT-4.1 NOT EQUALS "PP" OR PRT-4.3 NOT EQUALS "HL70443" | (PRT.element(4.1)!="PP")or(PRT.element(4.3)!="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | RelatedPerson | PRT[RelatedPerson] | RelatedPerson.patient.reference=Patient[1].id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. |
4.1.4 | ORU_R01.PATIENT_RESULT.PATIENT.NTE | [{NTE}] | Notes and Comments | 0 | -1 | |||||||
4.1.5 | ORU_R01.PATIENT_RESULT.PATIENT.NK1 | [{NK1}] | Next of Kin/Associated Parties | 0 | -1 | The FHIR location will depend on the nature of the data being exchanged and how the systems use next of kin data | RelatedPerson | NK1[RelatedPerson] | RelatedPerson.patient.reference=Patient[1].id | Typically, each NK1 will be translated to either a new RelatedPerson resource or added as a new occurrence of Patient.contact, but it's possible to insert the NK1 data into both structures. | ||
4.1.5 | ORU_R01.PATIENT_RESULT.PATIENT.NK1 | [{NK1}] | Next of Kin/Associated Parties | 0 | -1 | The FHIR location will depend on the nature of the data being exchanged and how the systems use next of kin data | Patient | NK1[Patient] | Typically, each NK1 will be translated to either a new RelatedPerson resource or added as a new occurrence of Patient.contact, but it's possible to insert the NK1 data into both structures. | |||
4.1.6 | ORU_R01.PATIENT_RESULT.PATIENT.ARV | [{ARV}] | Access Restrictions | 0 | -1 | |||||||
4.1.7 | ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION | [{ | --- PATIENT_OBSERVATION begin | 0 | -1 | |||||||
4.1.7.1 | ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.OBX | OBX | Observation (for Patient ID) | 1 | 1 | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | Observation | OBX[Observation] | Observation.subject.reference=Patient[1].id | |||
4.1.7.1 | ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.OBX | OBX | Observation (for Patient ID) | 1 | 1 | IF OBX-5 LST.count GREATER THAN 1 | Observation | OBX[Observation-Component] | Observation.subject.reference=Patient[1].id | Note that when OBX-5 repeats, the standard mapping is to use Observation.component 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. | ||
4.1.7.2 | ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | IF PRT-10 VALUED | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | Device | PRT[Device] | Observation[1].device.reference=Device.id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |
4.1.7.2 | ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | IF PRT-9 VALUED OR IF PRT-14 VALUED | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | Observation | PRT[Observation-Location] | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | ||
4.1.7.2 | ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | IF PRT-5 VALUED | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | Observation.performer.reference=PractitionerRole[1].id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |
4.1.7.3 | /ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION | }] | --- PATIENT_OBSERVATION end | |||||||||
4.1.8 | ORU_R01.PATIENT_RESULT.PATIENT.VISIT | [ | --- VISIT begin | 0 | 1 | |||||||
4.1.8.1 | ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PV1 | PV1 | Patient Visit | 1 | 1 | Encounter | PV1[Encounter] | Encounter.subject.reference=Patient[1].id | Processing of the PV1 segment results in the creation of a new Encounter resource | |||
4.1.8.1 | ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PV1 | PV1 | Patient Visit | 1 | 1 | Patient | PV1[Patient] | |||||
4.1.8.2 | ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PV2 | [PV2] | Patient Visit - Additional Info | 0 | 1 | Encounter | PV2[Encounter] | Encounter.subject.reference=Patient[1].id | Incorporate PV2 content into the Encounter created from the PV1 segment. | |||
4.1.8.3 | ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PRT | [{PRT}] | Participation (for Patient Visit) | 0 | -1 | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | Encounter[1].participant.individual.reference=PractitionerRole[2].id | Incorporate PRT content into the Encounter created from the PV1 segment. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | ||
4.1.8.4 | /ORU_R01.PATIENT_RESULT.PATIENT.VISIT | ] | --- VISIT end | |||||||||
4.1.9 | /ORU_R01.PATIENT_RESULT.PATIENT | ] | --- PATIENT end | |||||||||
4.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION | { | --- ORDER_OBSERVATION begin | 1 | -1 | |||||||
4.2.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER | [ | --- COMMON_ORDER begin | 0 | 1 | |||||||
4.2.1.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORC | ORC | Order common | 1 | 1 | DiagnosticReport | ORC[DiagnosticReport] | DiagnosticReport[1].encounter.reference=Encounter[1].id | Processing of each ORC segment results in the creation of a new DiagnosticReport resource | |||
4.2.1.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORC | ORC | Order common | 1 | 1 | If a ServiceRequest needs to be created for the receiver. | ServiceRequest | ORC[ServiceRequest] | DiagnosticReport[1].basedOn.reference=ServiceRequest[1].id | |||
4.2.1.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.PRT | [{PRT}] | Participation (for Observation) | 0 | -1 | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | ServiceRequest[1].requester.reference=PractitionerRole[3].id | |
4.2.1.3 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORDER_DOCUMENT | [ | --- ORDER_DOCUMENT begin | 0 | 1 | Will be addressed with FHIR R5. | ||||||
4.2.1.3.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORDER_DOCUMENT.OBX | OBX | Observation containing Document | 1 | 1 | |||||||
4.2.1.3.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORDER_DOCUMENT.PRT | [{PRT}] | Participation | 0 | -1 | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||
4.2.1.3.3 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORDER_DOCUMENT.TXA | TXA | Transcription Document Header | 1 | 1 | |||||||
4.2.1.3.4 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORDER_DOCUMENT | ] | --- ORDER DOCUMENT end | |||||||||
4.2.1.4 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER | ] | --- COMMON ORDER end | |||||||||
4.2.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBR | OBR | Observations Request | 1 | 1 | DiagnosticReport | OBR[DiagnosticReport] | Incorporate OBR content into the DiagnosticReport created from the ORC segment in the same segment group. | ||||
4.2.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBR | OBR | Observations Request | 1 | 1 | Specimen | OBR[Specimen] | DiagnosticReport[1].specimen.reference=Specimen.id | The OBR specimen data yields one Specimen resource that all Observations generated for the same OBR need to reference. | |||
4.2.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBR | OBR | Observations Request | 1 | 1 | IF ORC VALUED | If a ServiceRequest needs to be created for the receiver. | ServiceRequest | OBR[ServiceRequest] | Mapping to ServiceRequest as well is needed if the receiver is not the originator of the order to which this results message responds. This mapping will be completed once OMG/OML mapping is sufficiently completed. We will add the other segment mappings below to ServiceRequest then as well. | ||
4.2.3 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.NTE | {[NTE]} | Notes and comments | 0 | -1 | |||||||
4.2.4 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | [{PRT}] | Participation (for Observation) | 0 | -1 | IF PRT-4.1 IN ("ARI","TN","TR") AND PRT-4.3 EQUALS "HL70443" | PRT.element(4.1) in ("ARI","TN", "TR")and(PRT.element(4.3)="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | DiagnosticReport[1].performer.reference=PractitionerRole[4].id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. |
4.2.4 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | [{PRT}] | Participation (for Observation) | 0 | -1 | IF PRT-4.1 EQUALS "PRI" AND PRT-4.3 EQUALS "HL70443" | (PRT.element(4.1)="PRI")and(PRT.element(4.3)="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | DiagnosticReport[1].resultsInterpreter.reference=PractitionerRole[5].id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. |
4.2.4 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | [{PRT}] | Participation (for Observation) | 0 | -1 | IF PRT-4.1 EQUALS "SC" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="SC")and(element("4.3")="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | DiagnosticReport[1].specimen[1](Specimen.collection.collector.reference)=PractitionerRole[6].id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. |
4.2.4 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | [{PRT}] | Participation (for Observation) | 0 | -1 | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | DiagnosticReport[1].requester.reference=PractitionerRole[3].id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. |
4.2.4.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.TIMING_QTY | [{ | --- TIMING_QTY begin | 0 | -1 | |||||||
4.2.4.1.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.TIMING_QTY.TQ1 | TQ1 | Timing/Quantity | 1 | 1 | |||||||
4.2.4.1.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.TIMING_QTY.TQ2 | [{TQ2}] | Timing/Quantity Order Sequence | 0 | -1 | |||||||
4.2.4.1.3 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.TIMING_QTY | }] | --- TIMING_QTY end | |||||||||
4.2.4.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.CTD | [CTD] | Contact Data | 0 | 1 | |||||||
4.2.4.3 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION | [{ | --- OBSERVATION begin | 0 | -1 | |||||||
4.2.4.3.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | OBX | Observation related to OBR | 1 | 1 | IF OBX-5 LST.count LESS THAN OR EQUALS 1 AND OBX-29 NOT IN ("QST", "SCI") | Observation | OBX[Observation] | DiagnosticReport.result.reference=Observation[2].id Observation[2].subject.reference=Patient[1].id; Observation[2].encounter.reference=Encounter[1].id | Implementers should consider the use case where OBX-5 repeats in a given OBX segment. Because the Observation value element is not allowed to repeat, multiple occurrences of OBX-5 must be handled either through the creation of multiple Observation resources, the use of Observation components, the concatenation of the results into a single value or another solution appropriate for the data and the implementation. Note that it is not clear that every OBX represents a results that can be associated with the encounter during which it was ordered/performed. | ||
4.2.4.3.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | OBX | Observation related to OBR | 1 | 1 | IF OBX-5 LST.count GREATER THAN 1 AND OBX-29 NOT IN ("QST", "SCI") | Observation | OBX[Observation-Component] | DiagnosticReport.result.reference=Observation[2].id Observation[2].subject.reference=Patient[1].id; Observation[2].encounter.reference=Encounter[1].id | Implementers should consider the use case where OBX-5 repeats in a given OBX segment. Because the Observation value element is not allowed to repeat, multiple occurrences of OBX-5 must be handled either through the creation of multiple Observation resources, the use of Observation components, the concatenation of the results into a single value or another solution appropriate for the data and the implementation. When multiple OBX segments are tranformed into Observation components in a single Observation resource, implementers should consider how the metadata associated with the result (eg performer, status, date/time, etc) are populated. If the OBX segments being combined into a single resource contain different metadata, it must be considered whether or not the use of components is appropriate. | ||
4.2.4.3.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | OBX | Observation related to OBR | 1 | 1 | IF OBX-5 LST.count LESS THAN OR EQUALS 1 AND OBX-29 IN ("QST", "SCI") | Observation | OBX[Observation] | ServiceRequest[1].supportingInfo.reference=Observation[1].id; Observation[1].subject.id=Patient[1].id | |||
4.2.4.3.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | OBX | Observation related to OBR | 1 | 1 | IF OBX-5 LST.count GREATER THAN 1 AND OBX-29 AND OBX-29 IN ("QST", "SCI") | Observation | OBX[Observation-Component] | ServiceRequest[1].supportingInfo.reference=Observation[1].id; Observation[1].subject.id=Patient[1].id | |||
4.2.4.3.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | IF PRT-10 VALUED | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | Device | PRT[Device] | Observation[2].device.reference=Device.id | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |
4.2.4.3.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | IF PRT-9 VALUED OR IF PRT-14 VALUED | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | Observation | PRT[Observation-Location] | Incorporate PRT content into the Observation created from the OBX segment in the same segment group when it represents observation location information. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | ||
4.2.4.3.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | IF PRT-5 VALUED | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | PractitionerRole | PRT[PractitionerRole] | Observation[2].performer.reference=PractitionerRole[7].id | Incorporate PRT content into the Observation created from the OBX segment in the same segment group when it represents observation practitioner information. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |
4.2.4.3.3 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.NTE | {[NTE]} | Notes and comments | 0 | -1 | Observation.note | NTE[ServiceRequest] | |||||
4.2.4.3 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION | }] | --- OBSERVATION end | |||||||||
4.2.5 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.FT1 | [{FT1}] | Financial Transaction | 0 | -1 | |||||||
4.2.6 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.CTI | {[CTI]} | Clinical Trial Identification | 0 | -1 | |||||||
4.2.7 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN | [{ | --- SPECIMEN begin | 0 | -1 | |||||||
4.2.7.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPM | SPM | Specimen | 1 | 1 | Specimen | SPM[Specimen] | DiagnosticReport[1].specimen.reference=Specimen[n].id | ||||
4.2.7.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION | [{ | --- SPECIMEN_OBSERVATION begin | 0 | -1 | |||||||
4.2.7.2.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION.OBX | OBX | Observation (for Patient ID) | 1 | 1 | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | Observation | OBX[Observation] | Observation[3].subject.reference=Patient[1].id Observation[3].focus.reference=Specimen[n].id | |||
4.2.7.2.1 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION.OBX | OBX | Observation (for Patient ID) | 1 | 1 | IF OBX-5 LST.count GREATER THAN 1 | Observation | OBX[Observation-Component] | Observation[3].subject.reference=Patient[1].id Observation[3].focus.reference=Specimen[n].id | |||
4.2.7.2.2 | ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION.PRT | [{PRT}] | Participation (Observation Participation) | 0 | -1 | |||||||
4.2.7.2.3 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION | }] | --- SPECIMEN_OBSERVATION end | |||||||||
4.2.7.3 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN | }] | --- SPECIMEN end | |||||||||
4.2.8 | /ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION | } | --- ORDER_OBSERVATION end | |||||||||
4.3 | /ORU_R01.PATIENT_RESULT | } | --- PATIENT_RESULT end | |||||||||
5 | ORU_R01.DSC | [DSC] | Continuation Pointer |
Mapping from ORU_R01 to Bundle
ACTIVE (not intended for production usage). Published on 2023-12-19 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 Message ORU_R01 to the FHIR Message Bundle.
Group 1Mapping from unspecified code system
to unspecified code system
Source Concept Details | Relationship | Target Concept Details | Comment | Properties | |||||||||||
Codes from | segmentmap | references | Codes from | narrative | antlr | fhirpath | |||||||||
ORU_R01.MSH | Message Header | MSH[Bundle] | is equivalent to | Bundle | Bundle | ||||||||||
ORU_R01.MSH | Message Header | MSH[MessageHeader] | is equivalent to | MessageHeader[1] | MessageHeader[1] | Processing of the MSH segment results in the creation of a new MessageHeader resource | |||||||||
ORU_R01.MSH | Message Header | MSH[Provenance-Source] | Provenance[1].target.reference=Bundle.id; Provenance[1].target.reference=MessageHeader[1].id | is equivalent to | Provenance[1] | Provenance[1] | If there is a source in MSH-4, or known based on the configuration. | If the FHIR transformation does not yield a FHIR message, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Provenance resource instance to the relevant FHIR resources generated. | |||||||
ORU_R01.MSH | Message Header | MSH[Provenance-Transformation] | Provenance[2].target.reference=Bundle.id | is equivalent to | Provenance[2] | Provenance[2] | If the FHIR transformation does not yield a FHIR Bunlde, but only a set of resource (APIs, repository, etc.) than one should consider attaching this Provenance resource instance to the relevant FHIR resources generated. | ||||||||
ORU_R01.SFT | Software Segment | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="derivation"\ | is equivalent to | Provenance[1].entity.what(Device) | Provenance[1].entity.what(Device) | If the software does represent not the original source system | ||||||||
ORU_R01.SFT | Software Segment | SFT[Device] | Provenance[1].entity.what.reference=Device.id Provenance[1].entity.role="source"\ | is equivalent to | Provenance[1].entity.what(Device) | Provenance[1].entity.what(Device) | If the software represents the original source system | ||||||||
ORU_R01.PATIENT_RESULT.PATIENT.PID | Patient Identification | PID[Patient] | is equivalent to | Patient[1] | Patient[1] | Processing of the PID segment results in the creation of a new Patient resource | |||||||||
ORU_R01.PATIENT_RESULT.PATIENT.PID | Patient Identification | PID[Provenance-Patient] | Provenance.target.reference=Patient[1].id | is equivalent to | Provenance[4] | Provenance[4] | One may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date. | IF PID-33 AND PID-34 VALUED | |||||||
ORU_R01.PATIENT_RESULT.PATIENT.PD1 | Additional Demographics | PD1[Patient] | is equivalent to | Patient[1] | Patient[1] | Incorporate PD1 content into the Patient created from the PID segment. | |||||||||
ORU_R01.PATIENT_RESULT.PATIENT.PRT | Participation (for Patient) | PRT[PractitionerRole] | Patient[1].generalPractitioner.reference=PractitionerRole[1].id | is equivalent to | PractitionerRole[1] | PractitionerRole[1] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 EQUALS "PP" AND PRT-4.3 EQUALS "HL70443" | (PRT.element(4.1)="PP")and(PRT.element(4.3)="HL70443") | Incorporate PRT content into the Patient created from the PID segment when the PRT contains practitioner related data. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale.\ | |||||
ORU_R01.PATIENT_RESULT.PATIENT.PRT | Participation (for Patient) | PRT[RelatedPerson] | RelatedPerson.patient.reference=Patient[1].id | is equivalent to | RelatedPerson[1] | RelatedPerson[1] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 NOT EQUALS "PP" OR PRT-4.3 NOT EQUALS "HL70443" | (PRT.element(4.1)!="PP")or(PRT.element(4.3)!="HL70443") | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||
ORU_R01.PATIENT_RESULT.PATIENT.NK1 | Next of Kin/Associated Parties | NK1[RelatedPerson] | RelatedPerson.patient.reference=Patient[1].id | is equivalent to | RelatedPerson[2] | RelatedPerson[2] | The FHIR location will depend on the nature of the data being exchanged and how the systems use next of kin data | Typically, each NK1 will be translated to either a new RelatedPerson resource or added as a new occurrence of Patient.contact, but it's possible to insert the NK1 data into both structures. | |||||||
ORU_R01.PATIENT_RESULT.PATIENT.NK1 | Next of Kin/Associated Parties | NK1[Patient] | is equivalent to | Patient[1] | Patient[1] | The FHIR location will depend on the nature of the data being exchanged and how the systems use next of kin data | Typically, each NK1 will be translated to either a new RelatedPerson resource or added as a new occurrence of Patient.contact, but it's possible to insert the NK1 data into both structures. | ||||||||
ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.OBX | Observation (for Patient ID) | OBX[Observation] | Observation.subject.reference=Patient[1].id | is equivalent to | Observation[1] | Observation[1] | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | ||||||||
ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.OBX | Observation (for Patient ID) | OBX[Observation-Component] | Observation.subject.reference=Patient[1].id | is equivalent to | Observation[1] | Observation[1] | IF OBX-5 LST.count GREATER THAN 1 | Note that when OBX-5 repeats, the standard mapping is to use Observation.component 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. | |||||||
ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.PRT | Participation (Observation Participation) | PRT[Device] | Observation[1].device.reference=Device.id | is equivalent to | Device | Device | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-10 VALUED | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | ||||||
ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.PRT | Participation (Observation Participation) | PRT[Observation-Location] | is equivalent to | Observation[1] | Observation[1] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-9 VALUED OR IF PRT-14 VALUED | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||||
ORU_R01.PATIENT_RESULT.PATIENT.PATIENT_OBSERVATION.PRT | Participation (Observation Participation) | PRT[PractitionerRole] | Observation.performer.reference=PractitionerRole[1].id | is equivalent to | PractitionerRole[1] | PractitionerRole[1] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-5 VALUED | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | ||||||
ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PV1 | Patient Visit | PV1[Encounter] | Encounter.subject.reference=Patient[1].id | is equivalent to | Encounter[1] | Encounter[1] | Processing of the PV1 segment results in the creation of a new Encounter resource | ||||||||
ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PV1 | Patient Visit | PV1[Patient] | is equivalent to | Patient[1] | Patient[1] | ||||||||||
ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PV2 | Patient Visit - Additional Info | PV2[Encounter] | Encounter.subject.reference=Patient[1].id | is equivalent to | Encounter[1] | Encounter[1] | Incorporate PV2 content into the Encounter created from the PV1 segment. | ||||||||
ORU_R01.PATIENT_RESULT.PATIENT.VISIT.PRT | Participation (for Patient Visit) | PRT[PractitionerRole] | Encounter[1].participant.individual.reference=PractitionerRole[2].id | is equivalent to | PractitionerRole[2] | PractitionerRole[2] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | Incorporate PRT content into the Encounter created from the PV1 segment. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale.\ | |||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORC | Order common | ORC[DiagnosticReport] | DiagnosticReport[1].encounter.reference=Encounter[1].id | is equivalent to | DiagnosticReport[1] | DiagnosticReport[1] | Processing of each ORC segment results in the creation of a new DiagnosticReport resource | ||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.ORC | Order common | ORC[ServiceRequest] | DiagnosticReport[1].basedOn.reference=ServiceRequest[1].id | is equivalent to | ServiceRequest[1] | ServiceRequest[1] | If a ServiceRequest needs to be created for the receiver. | ||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.COMMON_ORDER.PRT | Participation (for Observation) | PRT[PractitionerRole] | ServiceRequest[1].requester.reference=PractitionerRole[3].id | is equivalent to | PractitionerRole[3] | PractitionerRole[3] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | ||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBR | Observations Request | OBR[DiagnosticReport] | is equivalent to | DiagnosticReport[1] | DiagnosticReport[1] | Incorporate OBR content into the DiagnosticReport created from the ORC segment in the same segment group. | |||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBR | Observations Request | OBR[Specimen] | DiagnosticReport[1].specimen.reference=Specimen.id | is equivalent to | Specimen[1] | Specimen[1] | The OBR specimen data yields one Specimen resource that all Observations generated for the same OBR need to reference. | ||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBR | Observations Request | OBR[ServiceRequest] | is equivalent to | ServiceRequest[1] | ServiceRequest[1] | If a ServiceRequest needs to be created for the receiver. | IF ORC VALUED | Mapping to ServiceRequest as well is needed if the receiver is not the originator of the order to which this results message responds. This mapping will be completed once OMG/OML mapping is sufficiently completed. We will add the other segment mappings below to ServiceRequest then as well. | |||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | Participation (for Observation) | PRT[PractitionerRole] | DiagnosticReport[1].performer.reference=PractitionerRole[4].id | is equivalent to | PractitionerRole[4] | PractitionerRole[4] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 IN ("ARI","TN","TR") AND PRT-4.3 EQUALS "HL70443" | PRT.element(4.1) in ("ARI","TN", "TR")and(PRT.element(4.3)="HL70443") | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | Participation (for Observation) | PRT[PractitionerRole] | DiagnosticReport[1].resultsInterpreter.reference=PractitionerRole[5].id | is equivalent to | PractitionerRole[5] | PractitionerRole[5] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 EQUALS "PRI" AND PRT-4.3 EQUALS "HL70443" | (PRT.element(4.1)="PRI")and(PRT.element(4.3)="HL70443") | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | Participation (for Observation) | PRT[PractitionerRole] | DiagnosticReport[1].specimen[1](Specimen.collection.collector.reference)=PractitionerRole[6].id | is equivalent to | PractitionerRole[6] | PractitionerRole[6] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 EQUALS "SC" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="SC")and(element("4.3")="HL70443") | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.PRT | Participation (for Observation) | PRT[PractitionerRole] | DiagnosticReport[1].requester.reference=PractitionerRole[3].id | is equivalent to | PractitionerRole[3] | PractitionerRole[3] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | |||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | Observation related to OBR | OBX[Observation] | DiagnosticReport.result.reference=Observation[2].id Observation[2].subject.reference=Patient[1].id; Observation[2].encounter.reference=Encounter[1].id\ | is equivalent to | Observation[2] | Observation[2] | IF OBX-5 LST.count LESS THAN OR EQUALS 1 AND OBX-29 NOT IN ("QST", "SCI") | Implementers should consider the use case where OBX-5 repeats in a given OBX segment. Because the Observation value element is not allowed to repeat, multiple occurrences of OBX-5 must be handled either through the creation of multiple Observation resources, the use of Observation components, the concatenation of the results into a single value or another solution appropriate for the data and the implementation. Note that it is not clear that every OBX represents a results that can be associated with the encounter during which it was ordered/performed.\ | |||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | Observation related to OBR | OBX[Observation-Component] | DiagnosticReport.result.reference=Observation[2].id Observation[2].subject.reference=Patient[1].id; Observation[2].encounter.reference=Encounter[1].id\ | is equivalent to | Observation[2] | Observation[2] | IF OBX-5 LST.count GREATER THAN 1 AND OBX-29 NOT IN ("QST", "SCI") | Implementers should consider the use case where OBX-5 repeats in a given OBX segment. Because the Observation value element is not allowed to repeat, multiple occurrences of OBX-5 must be handled either through the creation of multiple Observation resources, the use of Observation components, the concatenation of the results into a single value or another solution appropriate for the data and the implementation. When multiple OBX segments are tranformed into Observation components in a single Observation resource, implementers should consider how the metadata associated with the result (eg performer, status, date/time, etc) are populated. If the OBX segments being combined into a single resource contain different metadata, it must be considered whether or not the use of components is appropriate. | |||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | Observation related to OBR | OBX[Observation] | ServiceRequest[1].supportingInfo.reference=Observation[1].id; Observation[1].subject.id=Patient[1].id | is equivalent to | Observation[2] | Observation[2] | IF OBX-5 LST.count LESS THAN OR EQUALS 1 AND OBX-29 IN ("QST", "SCI") | ||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.OBX | Observation related to OBR | OBX[Observation-Component] | ServiceRequest[1].supportingInfo.reference=Observation[1].id; Observation[1].subject.id=Patient[1].id | is equivalent to | Observation[2] | Observation[2] | IF OBX-5 LST.count GREATER THAN 1 AND OBX-29 AND OBX-29 IN ("QST", "SCI") | ||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.PRT | Participation (Observation Participation) | PRT[Device] | Observation[2].device.reference=Device.id | is equivalent to | Device | Device | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-10 VALUED | If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale. | ||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.PRT | Participation (Observation Participation) | PRT[Observation-Location] | is equivalent to | Observation[2] | Observation[2] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-9 VALUED OR IF PRT-14 VALUED | Incorporate PRT content into the Observation created from the OBX segment in the same segment group when it represents observation location information. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale.\ | |||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.PRT | Participation (Observation Participation) | PRT[PractitionerRole] | Observation[2].performer.reference=PractitionerRole[7].id | is equivalent to | PractitionerRole[7] | PractitionerRole[7] | If PRT-2 is valued to "D", delete, then the implementer needs to consider whether to create a Device with Device.status = "inactive". | IF PRT-5 VALUED | Incorporate PRT content into the Observation created from the OBX segment in the same segment group when it represents observation practitioner information. If PRT-2 is set to "D" and "inactive" cannot be used, please submit a JIRA with context and rationale.\ | ||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.OBSERVATION.NTE | Notes and comments | NTE[ServiceRequest] | is equivalent to | Observation[2].note | Observation[2].note | ||||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPM | Specimen | SPM[Specimen] | DiagnosticReport[1].specimen.reference=Specimen[n].id | is equivalent to | Specimen[n] | Specimen[n] | |||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION.OBX | Observation (for Patient ID) | OBX[Observation] | Observation[3].subject.reference=Patient[1].id Observation[3].focus.reference=Specimen[n].id\ | is equivalent to | Observation[3] | Observation[3] | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | ||||||||
ORU_R01.PATIENT_RESULT.ORDER_OBSERVATION.SPECIMEN.SPECIMEN_OBSERVATION.OBX | Observation (for Patient ID) | OBX[Observation-Component] | Observation[3].subject.reference=Patient[1].id Observation[3].focus.reference=Specimen[n].id\ | is equivalent to | Observation[3] | Observation[3] | IF OBX-5 LST.count GREATER THAN 1 |