HL7 Version 2 to FHIR
0.1.0 - STU1 Ballot
HL7 Version 2 to FHIR
0.1.0 - STU1 Ballot
This page is part of the HL7 Version 2 to FHIR (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
This ConceptMap represents the mapping from the HL7 V2 VXU_V04 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 | VXU_V04.MSH | MSH | Message Header | 1 | 1 | Bundle | MSH[Bundle] | |||||
| 1 | VXU_V04.MSH | MSH | Message Header Segment | 1 | 1 | MessageHeader | MSH[MessageHeader] | Processing of the MSH segment results in the creation of a new MessageHeader resource | ||||
| 1 | VXU_V04.MSH | MSH | Message Header Segment | 1 | 1 | Provenance | MSH[Provenance] | Provenance.target=Bundle; Provenance.target=MessageHeader[MSH] | ||||
| 2 | VXU_V04.SFT | [{ SFT }] | Software | 0 | -1 | MessageHeader | SFT[MessageHeader] | Incorporate SFT content for each of the SFT instances into the MessageHeader created from the MSH segment. | ||||
| 3 | VXU_V04.UAC | [ UAC ] | User Authentication Credential | 0 | 1 | |||||||
| 4 | VXU_V04.PID | PID | Patient Identification Segment | 1 | 1 | Patient | PID[Patient] | Processing of the PID segment results in the creation of a new Patient resource | ||||
| 5 | VXU_V04.PD1 | [ PD1 ] | Additional Demographics | 0 | 1 | Patient | PD1[Patient] | Incorporate PD1 content into the Patient created from the PID segment. | ||||
| 6 | VXU_V04.NK1 | [{ NK1 }] | Next of Kin/Associated Parties | 0 | -1 | RelatedPerson | NK1[RelatedPerson] | RelatedPerson.patient.reference=Patient[PID].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. | |||
| 6 | VXU_V04.NK1 | [{ NK1 }] | Next of Kin/Associated Parties | 0 | -1 | Patient | NK1[Patient] | |||||
| 7 | VXU_V04.ARV | [{ ARV }] | Access Restrictions | 0 | -1 | |||||||
| 8 | VXU_V04.PATIENT_VISIT | [ | --- PATIENT_VISIT begin | 0 | 1 | |||||||
| 8.1 | VXU_V04.PATIENT_VISIT.PV1 | PV1 | Patient Visit | 1 | 1 | Only if the system wants to know about the encounter related to the immunization event | Encounter | PV1[Encounter] | Encounter.subject.reference=Patient[PID].id | Processing of the PV1 segment results in the creation of a new Encounter resource | ||
| 8.1 | VXU_V04.PATIENT_VISIT.PV1 | PV1 | Patient Visit | 1 | 1 | Patient | PV1[Patient] | |||||
| 8.2 | VXU_V04.PATIENT_VISIT.PV2 | [ PV2 ] | Patient Visit – Additional Info | 0 | 1 | Encounter | PV2[Encounter] | Incorporate PV2 content into the Encounter created from the PV1 segment. | ||||
| 8.3 | VXU_V04.PATIENT_VISIT.ARV | [{ ARV }] | Access Restrictions | 0 | -1 | |||||||
| 8.4 | /VXU_V04.PATIENT_VISIT | ] | --- PATIENT_VISIT end | |||||||||
| 9 | VXU_V04.GT1 | [{ GT1 }] | Guarantor | 0 | -1 | |||||||
| 10 | VXU_V04.INSURANCE | [{ | --- INSURANCE begin | 0 | -1 | |||||||
| 10.1 | VXU_V04.INSURANCE | IN1 | Insurance | 1 | 1 | Processing of the IN1 segment results in the creation of a new Coverage resource | ||||||
| 10.2 | VXU_V04.INSURANCE | [ IN2 ] | Insurance Additional Information | 0 | 1 | Incorporate IN2 content into the Coverage created from the IN1 segment. | ||||||
| 10.3 | VXU_V04.INSURANCE | [ IN3 ] | Insurance Additional Information, Certification | 0 | 1 | Incorporate IN3 content into the Coverage created from the IN1 segment. | ||||||
| 10.4 | /VXU_V04.INSURANCE | }] | --- INSURANCE end | |||||||||
| 11 | VXU_V04.PERSON_OBSERVATION | [{ | --- PERSON_OBSERVATION begin | 0 | -1 | |||||||
| 11.1 | VXU_V04.PERSON_OBSERVATION.OBX | OBX | Observation/Result | 1 | 1 | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | Observation | OBX[Observation] | Observation.subject.reference=Patient[1].id | |||
| 11.1 | VXU_V04.PERSON_OBSERVATION.OBX | OBX | Observation/Result | 1 | 1 | IF OBX-5 LST.count GREATER THAN 1 | Observation | OBX[Observation-Component] | Observation.subject.reference=Patient[1].id | |||
| 11.2 | VXU_V04.PERSON_OBSERVATION.PRT | [{ PRT }] | Participation (for Observation) | 0 | -1 | IF PRT-10 VALUED | Device | PRT[Device] | Observation[1].device.reference=Device.id | |||
| 11.2 | VXU_V04.PERSON_OBSERVATION.PRT | [{ PRT }] | Participation (for Observation) | 0 | -1 | IF PRT-9 VALUED OR IF PRT-14 VALUED | Observation | PRT[Observation-Location] | At this time we don't know of a use case for sending a location PRT to a patient level observations. We've provided a mapping from PRT to Location but not way to link it to other resources in the Bundle. If there is a known use case, please comment on it so that we can develop a solution. | |||
| 11.2 | VXU_V04.PERSON_OBSERVATION.PRT | [{ PRT }] | Participation (for Observation) | 0 | -1 | IF PRT-5 VALUED | PractitionerRole | PRT[PractitionerRole] | Observation.performer.reference=PractitionerRole[1].id | |||
| 11.3 | VXU_V04.PERSON_OBSERVATION.NTE | [{ NTE }] | Notes (Regarding Patient Observation) | 0 | -1 | Observation.note | NTE[Annotation] | |||||
| 11.4 | /VXU_V04.PERSON_OBSERVATION | }] | --- PERSON_OBSERVATION end | |||||||||
| 12 | VXU_V04.ORDER | [{ | --- ORDER begin | 0 | -1 | |||||||
| 12.1 | VXU_V04.ORDER.ORC | ORC | Common Order | 1 | 1 | Immunization | ORC[Immunization] | Immunzation.patient.reference=Patient[1].id | Processing of each ORC segment results in the creation of a new Immunization resource | |||
| 12.1 | VXU_V04.ORDER.ORC | ORC | Common Order | 1 | 1 | Only if the system wants to know about the order that lead to the immunization event | ServiceRequest | ORC[ServiceRequest] | ServiceRequest.subject.reference=Patient[1].id | Processing of each ORC segment results in the creation of a new ServiceRequest resource if the receiving system wants to know about the order that lead to the immunization event | ||
| 12.2 | VXU_V04.ORDER.PRT | [{PRT}] | Participation (for ORC) | 0 | -1 | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | PractitionerRole | PRT[PractitionerRole] | Immunization.performer.actor.reference=PractitionerRole[2].id | Processing of each PRT segment typically results in the creation of a new Practitioner or PractitionerRole resource. The decision between creating a Practitioner or PractitionerRole resource may depend on the availability of data related to the practitioner's role elsewhere in the message. It may be possible to reuse a Practitioner resource in the bundle created from somewhere else in the bundle rather than creating a new resource for each PRT segment (eg, the same administering practictioner resource could be pointed to from multiple order segment groups) - if an implementer decides to do this, the system must be certain that it's the same person (same name, ID, etc) potentially even playing the same role (if the bundle uses PractitionerRole in addition to Practitioner). | |
| 12.2 | VXU_V04.ORDER.PRT | [{PRT}] | Participation (for ORC) | 0 | -1 | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | Immunization.performer.function.coding.code | ||||
| 12.2 | VXU_V04.ORDER.PRT | [{PRT}] | Participation (for ORC) | 0 | -1 | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | Immunization.performer.function.coding.system | ||||
| 12.2 | VXU_V04.ORDER.PRT | [{PRT}] | Participation (for ORC) | 0 | -1 | IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="AP")and(element("4.3")="HL70443") | PractitionerRole | PRT[PractitionerRole] | Immunization.performer.actor.reference=PractitionerRole[3].id | ||
| 12.2 | VXU_V04.ORDER.PRT | [{PRT}] | Participation (for ORC) | 0 | -1 | IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="AP")and(element("4.3")="HL70443") | Immunization.performer.function.coding.code | ||||
| 12.2 | VXU_V04.ORDER.PRT | [{PRT}] | Participation (for ORC) | 0 | -1 | IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="AP")and(element("4.3")="HL70443") | Immunization.performer.function.coding.system | ||||
| 12.3 | VXU_V04.ORDER.TIMING | [{ | --- TIMING begin | 0 | -1 | |||||||
| 12.3.1 | VXU_V04.ORDER.TIMING.TQ1 | TQ1 | Timing/Quantity | 1 | 1 | |||||||
| 12.3.2 | VXU_V04.ORDER.TIMING.TQ2 | [{ TQ2 }] | Timing/Quantity Order Sequence | 0 | -1 | |||||||
| 12.3.3 | /VXU_V04.ORDER.TIMING | }] | --- TIMING end | |||||||||
| 12.4 | VXU_V04.ORDER.RXA | RXA | Pharmacy Administration Segment | 1 | 1 | Immunization | RXA[Immunization] | Incorporate RXA content into the Immunization created from the ORC segment in the same segment group. | ||||
| 12.5 | VXU_V04.ORDER.RXR | [ RXR ] | Pharmacy Route | 0 | 1 | Immunization | RXR[Immunization] | Incorporate RXR content into the Immunization created from the ORC segment in the same segment group. | ||||
| 12.6 | VXU_V04.ORDER.OBSERVATION | [{ | --- OBSERVATION begin | 0 | -1 | |||||||
| 12.6.1 | VXU_V04.ORDER.OBSERVATION.OBX | OBX | Observation/Result | 1 | 1 | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | Some observations about the immunization may map to elements within the Immuniation resource rather than an independent Observation resource. For example, funding source, patient eligibility and educational material are often sent as OBX segments but map to Immunization elements. Specific guidance on how to map, e.g., the US CDC implementation guide on immunizations, will be provided separately at a future time TBD. | Observation | OBX[Observation] | Observation.subject.reference=Patient[1].id; Observation.partOf.reference=Immunization[1].id | ||
| 12.6.1 | VXU_V04.ORDER.OBSERVATION.OBX | OBX | Observation/Result | 1 | 1 | IF OBX-5 LST.count GREATER THAN 1 | Some observations about the immunization may map to elements within the Immuniation resource rather than an independent Observation resource. For example, funding source, patient eligibility and educational material are often sent as OBX segments but map to Immunization elements. Specific guidance on how to map, e.g., the US CDC implementation guide on immunizations, will be provided separately at a future time TBD. | Observation | OBX[Observation-Component] | Observation.subject.reference=Patient[1].id; Observation.partOf.reference=Immunization[1].id | ||
| 12.6.2 | VXU_V04.ORDER.OBSERVATION.PRT | [{ PRT }] | Participation (for Observation) | 0 | -1 | IF PRT-10 VALUED | Device | PRT[Device] | Observation[1].device.reference=Device.id | |||
| 12.6.2 | VXU_V04.ORDER.OBSERVATION.PRT | [{ PRT }] | Participation (for Observation) | 0 | -1 | IF PRT-9 VALUED OR IF PRT-14 VALUED | Observation | PRT[Observation-Location] | ||||
| 12.6.2 | VXU_V04.ORDER.OBSERVATION.PRT | [{ PRT }] | Participation (for Observation) | 0 | -1 | IF PRT-5 VALUED | PractitionerRole | PRT[PractitionerRole] | Observation.performer.reference=PractitionerRole[1].id | |||
| 12.6.3 | VXU_V04.ORDER.OBSERVATION.NTE | [{ NTE }] | Notes (Regarding Immunization) | 0 | -1 | Observation.note | NTE[Annotation] | |||||
| 12.6.4 | /VXU_V04.ORDER.OBSERVATION | }] | --- OBSERVATION end | |||||||||
| 12.7 | /VXU_V04.ORDER | }] | --- ORDER end | |||||||||
Mapping from VXU_V04 to Bundle
ACTIVE (not intended for production usage). Published on 2020-08-12 by HL7 International (HL7 Orders and Observations Workgroup: http://hl7.org/Special/committ..., Keith W. Boone: kboone@ainq.com). Copyright (c) 2020, HL7 International, Inc., All Rights Reserved.
This ConceptMap represents a mapping from the HL7 V2 Message VXU_V04 to the FHIR Message Bundle.
| Source Concept Details | Relationship | Destination Concept Details | Comment | |||||||
| Code from | Code from | Code from | Code from | Code from | Code from | Code from | ||||
| VXU_V04.MSH | MSH[Bundle] | is equivalent to | Bundle | |||||||
| VXU_V04.MSH | MSH[MessageHeader] | is equivalent to | MessageHeader[1] | Processing of the MSH segment results in the creation of a new MessageHeader resource | ||||||
| VXU_V04.MSH | MSH[Provenance] | Provenance.target=Bundle; Provenance.target=MessageHeader[MSH] | is equivalent to | Provenance[1] | ||||||
| VXU_V04.SFT | SFT[MessageHeader] | is equivalent to | MessageHeader[1] | Incorporate SFT content for each of the SFT instances into the MessageHeader created from the MSH segment. | ||||||
| VXU_V04.PID | PID[Patient] | is equivalent to | Patient[1] | Processing of the PID segment results in the creation of a new Patient resource | ||||||
| VXU_V04.PD1 | PD1[Patient] | is equivalent to | Patient[1] | Incorporate PD1 content into the Patient created from the PID segment. | ||||||
| VXU_V04.NK1 | NK1[RelatedPerson] | RelatedPerson.patient.reference=Patient[PID].id | is equivalent to | RelatedPerson[1] | 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. | |||||
| VXU_V04.NK1 | NK1[Patient] | is equivalent to | Patient[1] | |||||||
| VXU_V04.PATIENT_VISIT.PV1 | PV1[Encounter] | Encounter.subject.reference=Patient[PID].id | is equivalent to | Encounter[1] | Only if the system wants to know about the encounter related to the immunization event | Processing of the PV1 segment results in the creation of a new Encounter resource | ||||
| VXU_V04.PATIENT_VISIT.PV1 | PV1[Patient] | is equivalent to | Patient[1] | |||||||
| VXU_V04.PATIENT_VISIT.PV2 | PV2[Encounter] | is equivalent to | Encounter[1] | Incorporate PV2 content into the Encounter created from the PV1 segment. | ||||||
| VXU_V04.PERSON_OBSERVATION.OBX | OBX[Observation] | Observation.subject.reference=Patient[1].id | is equivalent to | Observation[1] | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | |||||
| VXU_V04.PERSON_OBSERVATION.OBX | OBX[Observation-Component] | Observation.subject.reference=Patient[1].id | is equivalent to | Observation[1] | IF OBX-5 LST.count GREATER THAN 1 | |||||
| VXU_V04.PERSON_OBSERVATION.PRT | PRT[Device] | Observation[1].device.reference=Device.id | is equivalent to | Device[1] | IF PRT-10 VALUED | |||||
| VXU_V04.PERSON_OBSERVATION.PRT | PRT[Observation-Location] | is equivalent to | Observation[1] | IF PRT-9 VALUED OR IF PRT-14 VALUED | At this time we don't know of a use case for sending a location PRT to a patient level observations. We've provided a mapping from PRT to Location but not way to link it to other resources in the Bundle. If there is a known use case, please comment on it so that we can develop a solution. | |||||
| VXU_V04.PERSON_OBSERVATION.PRT | PRT[PractitionerRole] | Observation.performer.reference=PractitionerRole[1].id | is equivalent to | PractitionerRole[1] | IF PRT-5 VALUED | |||||
| VXU_V04.PERSON_OBSERVATION.NTE | NTE[Annotation] | is equivalent to | Observation[1].note | |||||||
| VXU_V04.ORDER.ORC | ORC[Immunization] | Immunzation.patient.reference=Patient[1].id | is equivalent to | Immunization[1] | Processing of each ORC segment results in the creation of a new Immunization resource | |||||
| VXU_V04.ORDER.ORC | ORC[ServiceRequest] | ServiceRequest.subject.reference=Patient[1].id | is equivalent to | ServiceRequest[1] | Only if the system wants to know about the order that lead to the immunization event | Processing of each ORC segment results in the creation of a new ServiceRequest resource if the receiving system wants to know about the order that lead to the immunization event | ||||
| VXU_V04.ORDER.PRT | PRT[PractitionerRole] | Immunization.performer.actor.reference=PractitionerRole[2].id | is equivalent to | PractitionerRole[2] | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | Processing of each PRT segment typically results in the creation of a new Practitioner or PractitionerRole resource. The decision between creating a Practitioner or PractitionerRole resource may depend on the availability of data related to the practitioner's role elsewhere in the message. It may be possible to reuse a Practitioner resource in the bundle created from somewhere else in the bundle rather than creating a new resource for each PRT segment (eg, the same administering practictioner resource could be pointed to from multiple order segment groups) - if an implementer decides to do this, the system must be certain that it's the same person (same name, ID, etc) potentially even playing the same role (if the bundle uses PractitionerRole in addition to Practitioner).\ | |||
| VXU_V04.ORDER.PRT | is equivalent to | Immunization[1].performer.function.coding.code | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | ||||||
| VXU_V04.ORDER.PRT | is equivalent to | Immunization[1].performer.function.coding.system | IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="OP")and(element("4.3")="HL70443") | ||||||
| VXU_V04.ORDER.PRT | PRT[PractitionerRole] | Immunization.performer.actor.reference=PractitionerRole[3].id | is equivalent to | PractitionerRole[3] | IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="AP")and(element("4.3")="HL70443") | ||||
| VXU_V04.ORDER.PRT | is equivalent to | Immunization[1].performer.function.coding.code | IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="AP")and(element("4.3")="HL70443") | ||||||
| VXU_V04.ORDER.PRT | is equivalent to | Immunization[1].performer.function.coding.system | IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443" | (element("4.1")="AP")and(element("4.3")="HL70443") | ||||||
| VXU_V04.ORDER.RXA | RXA[Immunization] | is equivalent to | Immunization[1] | Incorporate RXA content into the Immunization created from the ORC segment in the same segment group. | ||||||
| VXU_V04.ORDER.RXR | RXR[Immunization] | is equivalent to | Immunization[1] | Incorporate RXR content into the Immunization created from the ORC segment in the same segment group. | ||||||
| VXU_V04.ORDER.OBSERVATION.OBX | OBX[Observation] | Observation.subject.reference=Patient[1].id; Observation.partOf.reference=Immunization[1].id | is equivalent to | Observation[2] | Some observations about the immunization may map to elements within the Immuniation resource rather than an independent Observation resource. For example, funding source, patient eligibility and educational material are often sent as OBX segments but map to Immunization elements. Specific guidance on how to map, e.g., the US CDC implementation guide on immunizations, will be provided separately at a future time TBD. | IF OBX-5 LST.count LESS THAN OR EQUALS 1 | ||||
| VXU_V04.ORDER.OBSERVATION.OBX | OBX[Observation-Component] | Observation.subject.reference=Patient[1].id; Observation.partOf.reference=Immunization[1].id | is equivalent to | Observation[2] | Some observations about the immunization may map to elements within the Immuniation resource rather than an independent Observation resource. For example, funding source, patient eligibility and educational material are often sent as OBX segments but map to Immunization elements. Specific guidance on how to map, e.g., the US CDC implementation guide on immunizations, will be provided separately at a future time TBD. | IF OBX-5 LST.count GREATER THAN 1 | ||||
| VXU_V04.ORDER.OBSERVATION.PRT | PRT[Device] | Observation[1].device.reference=Device.id | is equivalent to | Device[2] | IF PRT-10 VALUED | |||||
| VXU_V04.ORDER.OBSERVATION.PRT | PRT[Observation-Location] | is equivalent to | Observation[2] | IF PRT-9 VALUED OR IF PRT-14 VALUED | ||||||
| VXU_V04.ORDER.OBSERVATION.PRT | PRT[PractitionerRole] | Observation.performer.reference=PractitionerRole[1].id | is equivalent to | PractitionerRole[4] | IF PRT-5 VALUED | |||||
| VXU_V04.ORDER.OBSERVATION.NTE | NTE[Annotation] | is equivalent to | Observation[2].note | |||||||
IG © 2020+ HL7 International. Package hl7.fhir.uv.v2mappings#0.1.0 based on FHIR 4.0.1. Generated 2020-08-12
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change