ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
HL7 v2Condition (IF True)HL7 FHIRComments
2
Sort OrderIdentifierSyntaxNameCardinality - MinCardinality - MaxComputable ANTLRComputable FHIRPathNarrativePrimary TargetSegment MapReferences
3
1VXU_V04.MSHMSHMessage Header11BundleMSH[Bundle]
4
1VXU_V04.MSHMSHMessage Header Segment11MessageHeader[1]
MSH[MessageHeader]
Processing of the MSH segment results in the creation of a new MessageHeader resource
5
1VXU_V04.MSHMSHMessage Header Segment11If there is a source in MSH-4, or known based on the configuration.Provenance[1]MSH[Provenance-Source]Provenance[1].target.reference=Bundle.id; Provenance[1].target.reference=MessageHeader[1].idIf 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.
6
1VXU_V04.MSHMSHMessage Header Segment11Provenance[2]MSH[Provenance-Transformation]Provenance[2].target.reference=Bundle.idIf 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.
7
2VXU_V04.SFT[{ SFT }]Software0-1If the software does represent not the original source system
Provenance[1].entity.what(Device)
SFT[Device]Provenance[1].entity.what.reference=Device.id
Provenance[1].entity.role="derivation"
8
2VXU_V04.SFT[{ SFT }]Software0-1If the software represents the original source system
Provenance[1].entity.what(Device)
SFT[Device]Provenance[1].entity.what.reference=Device.id
Provenance[1].entity.role="source"
9
3VXU_V04.UAC[ UAC ]
User Authentication Credential
01
10
4VXU_V04.PIDPID
Patient Identification Segment
11Patient[1]PID[Patient]Processing of the PID segment results in the creation of a new Patient resource
11
4VXU_V04.PIDPID
Patient Identification Segment
11IF PID-33 AND PID-34 VALUEDOne may drop PID-33 from the condition if PID-34 Last Update Facility is still sufficient without a date.Provenance[4]
PID[Provenance-Patient]
Provenance.target.reference=Patient[1].id
12
5VXU_V04.PD1[ PD1 ]Additional Demographics01Patient[1]PD1[Patient]Incorporate PD1 content into the Patient created from the PID segment.
13
5VXU_V04.PD1[ PD1 ]Additional Demographics01IF PD1-7 VALUEDObservation[3]
PD1[Observation-LivingWill]
Observation[3].subject.reference=Patient[1].id
14
6VXU_V04.NK1[{ NK1 }]
Next of Kin/Associated Parties
0-1RelatedPerson[1]
NK1[RelatedPerson]
RelatedPerson.patient.reference=Patient[PID].idTypically, 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.
15
6VXU_V04.NK1[{ NK1 }]
Next of Kin/Associated Parties
0-1Patient[1]NK1[Patient]
16
7VXU_V04.ARV[{ ARV }]Access Restrictions0-1
17
8VXU_V04.PATIENT_VISIT[--- PATIENT_VISIT begin01
18
8.1VXU_V04.PATIENT_VISIT.PV1PV1Patient Visit11Only if the system wants to know about the encounter related to the immunization eventEncounter[1]PV1[Encounter]Encounter.subject.reference=Patient[PID].idProcessing of the PV1 segment results in the creation of a new Encounter resource
19
8.1VXU_V04.PATIENT_VISIT.PV1PV1Patient Visit11IF PV1-43 VALUEDBasic
PV1[Basic-EncounterHistory]
Basic.extension-EncounterHistory.subject.reference=Patient[1].id
20
8.1VXU_V04.PATIENT_VISIT.PV1PV1Patient Visit11Patient[1]PV1[Patient]
21
8.1VXU_V04.PATIENT_VISIT.PV1PV1Patient Visit11IF PV1-20 VALUECoverage[1]PV1[Coverage]Coverage.beneficiary.reference=Patient[1].id
22
8.2VXU_V04.PATIENT_VISIT.PV2[ PV2 ]
Patient Visit – Additional Info
01Encounter[1]PV2[Encounter]Incorporate PV2 content into the Encounter created from the PV1 segment.
23
8.3VXU_V04.PATIENT_VISIT.ARV[{ ARV }]Access Restrictions0-1
24
8.4/VXU_V04.PATIENT_VISIT]--- PATIENT_VISIT end
25
9VXU_V04.GT1[{ GT1 }]Guarantor0-1
26
10VXU_V04.INSURANCE[{--- INSURANCE begin0-1
27
10.1VXU_V04.INSURANCEIN1Insurance11Processing of the IN1 segment results in the creation of a new Coverage resource
28
10.2VXU_V04.INSURANCE[ IN2 ]
Insurance Additional Information
01Incorporate IN2 content into the Coverage created from the IN1 segment.
29
10.3VXU_V04.INSURANCE[ IN3 ]
Insurance Additional Information, Certification
01Incorporate IN3 content into the Coverage created from the IN1 segment.
30
10.4/VXU_V04.INSURANCE}]--- INSURANCE end
31
11VXU_V04.PERSON_OBSERVATION[{
--- PERSON_OBSERVATION begin
0-1
32
11.1VXU_V04.PERSON_OBSERVATION.OBXOBXObservation/Result11IF OBX-5 LST.count LESS THAN OR EQUALS 1 OR OBX-2 IS "NA"Observation[1]OBX[Observation]
Observation[1].subject.reference=Patient[1].id
33
11.1VXU_V04.PERSON_OBSERVATION.OBXOBXObservation/Result11IF OBX-5 LST.count GREATER THAN 1 AND OBX-2 IS NOT "NA"Observation[1]
OBX[Observation-Component]
Observation[1].subject.reference=Patient[1].id
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.
34
11.2VXU_V04.PERSON_OBSERVATION.PRT[{ PRT }]
Participation (for Observation)
0-1IF PRT-10 VALUEDDevice[1]PRT[Device]Observation[1].device.reference=Device.id
35
11.2VXU_V04.PERSON_OBSERVATION.PRT[{ PRT }]
Participation (for Observation)
0-1
IF PRT-9 VALUED OR IF PRT-14 VALUED
Observation[1]
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.
36
11.2VXU_V04.PERSON_OBSERVATION.PRT[{ PRT }]
Participation (for Observation)
0-1IF PRT-5 VALUEDPractitionerRole[1]PRT[PractitionerRole]Observation.performer.reference=PractitionerRole[1].id
37
11.3VXU_V04.PERSON_OBSERVATION.NTE[{ NTE }]
Notes (Regarding Patient Observation)
0-1
Observation[1].note
NTE[ServiceRequest]
38
11.4/VXU_V04.PERSON_OBSERVATION}]
--- PERSON_OBSERVATION end
39
12VXU_V04.ORDER[{--- ORDER begin0-1
40
12.1VXU_V04.ORDER.ORCORCCommon Order11Immunization[1]ORC[Immunization]Immunzation.patient.reference=Patient[1].idProcessing of each ORC segment results in the creation of a new Immunization resource
41
12.1VXU_V04.ORDER.ORCORCCommon Order11Only if the system wants to know about the order that lead to the immunization eventServiceRequest[1]
ORC[ServiceRequest]
ServiceRequest.subject.reference=Patient[1].idProcessing 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
42
12.2VXU_V04.ORDER.PRT[{PRT}]Participation (for ORC)0-1IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443"(element("4.1")="OP")and(element("4.3")="HL70443")PractitionerRole[2]PRT[PractitionerRole]Immunization.performer.actor.reference=PractitionerRole[2].idProcessing 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).
43
12.2VXU_V04.ORDER.PRT[{PRT}]Participation (for ORC)0-1IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443"(element("4.1")="OP")and(element("4.3")="HL70443")
Immunization[1].performer.function.coding.code="OP'"
44
12.2VXU_V04.ORDER.PRT[{PRT}]Participation (for ORC)0-1IF PRT-4.1 EQUALS "OP" AND PRT-4.3 EQUALS "HL70443"(element("4.1")="OP")and(element("4.3")="HL70443")
Immunization[1].performer.function.coding.system="http://terminology.hl7.org/CodeSystem/v2-0443"
45
12.2VXU_V04.ORDER.PRT[{PRT}]Participation (for ORC)0-1IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443"(element("4.1")="AP")and(element("4.3")="HL70443")PractitionerRole[3]PRT[PractitionerRole]Immunization.performer.actor.reference=PractitionerRole[3].id
46
12.2VXU_V04.ORDER.PRT[{PRT}]Participation (for ORC)0-1IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443"(element("4.1")="AP")and(element("4.3")="HL70443")
Immunization[1].performer.function.coding.code="AP'"
47
12.2VXU_V04.ORDER.PRT[{PRT}]Participation (for ORC)0-1IF PRT-4.1 EQUALS "AP" AND PRT-4.3 EQUALS "HL70443"(element("4.1")="AP")and(element("4.3")="HL70443")
Immunization[1].performer.function.coding.system="http://terminology.hl7.org/CodeSystem/v2-0443"
48
12.3VXU_V04.ORDER.TIMING[{--- TIMING begin0-1
49
12.3.1VXU_V04.ORDER.TIMING.TQ1TQ1Timing/Quantity11
50
12.3.2VXU_V04.ORDER.TIMING.TQ2[{ TQ2 }]
Timing/Quantity Order Sequence
0-1
51
12.3.3/VXU_V04.ORDER.TIMING}]--- TIMING end
52
12.4VXU_V04.ORDER.RXARXA
Pharmacy Administration Segment
11Immunization[1]RXA[Immunization]Incorporate RXA content into the Immunization created from the ORC segment in the same segment group.
53
12.5VXU_V04.ORDER.RXR[ RXR ]Pharmacy Route01Immunization[1]RXR[Immunization]Incorporate RXR content into the Immunization created from the ORC segment in the same segment group.
54
12.6VXU_V04.ORDER.OBSERVATION[{--- OBSERVATION begin0-1
55
12.6.1VXU_V04.ORDER.OBSERVATION.OBXOBXObservation/Result11IF OBX-5 LST.count LESS THAN OR EQUALS 1 AND OBX-2 IS "NA"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[2]OBX[Observation]Observation[2].subject.reference=Patient[1].id; Observation[2].partOf.reference=Immunization[1].id
56
12.6.1VXU_V04.ORDER.OBSERVATION.OBXOBXObservation/Result11IF OBX-5 LST.count GREATER THAN 1 AND OBX-2 IS NOT "NA"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[2]
OBX[Observation-Component]
Observation[2].subject.reference=Patient[1].id; Observation[2].partOf.reference=Immunization[1].id
57
12.6.2VXU_V04.ORDER.OBSERVATION.PRT[{ PRT }]
Participation (for Observation)
0-1IF PRT-10 VALUEDDevice[2]PRT[Device]Observation[1].device.reference=Device.id
58
12.6.2VXU_V04.ORDER.OBSERVATION.PRT[{ PRT }]
Participation (for Observation)
0-1
IF PRT-9 VALUED OR IF PRT-14 VALUED
Observation[2]
PRT[Observation-Location]
59
12.6.2VXU_V04.ORDER.OBSERVATION.PRT[{ PRT }]
Participation (for Observation)
0-1IF PRT-5 VALUEDPractitionerRole[4]PRT[PractitionerRole]Observation[2].performer.reference=PractitionerRole[1].id
60
12.6.3VXU_V04.ORDER.OBSERVATION.NTE[{ NTE }]
Notes (Regarding Immunization)
0-1
Observation[2].note
NTE[ServiceRequest]
61
12.6.4/VXU_V04.ORDER.OBSERVATION}]--- OBSERVATION end
62
12.7/VXU_V04.ORDER}]--- ORDER end
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100