---
type: "mappings"
title: "Immunization Mappings"
resource: "Immunization"
---

# Immunization Mappings

- **Immunization**: workflow=Event; v2=VXU_V04; rim=SubstanceAdministration; w5=clinical.medication
- **Immunization.identifier**: workflow=Event.identifier; w5=FiveWs.identifier; rim=.id; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
- **Immunization.basedOn**: workflow=Event.basedOn; rim=N/A
- **Immunization.status**: workflow=Event.status; w5=FiveWs.status; rim=statusCode
- **Immunization.statusReason**: workflow=Event.statusReason; rim=.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
- **Immunization.vaccineCode**: workflow=Event.code; w5=FiveWs.what[x]; v2=RXA-5; rim=.code; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
- **Immunization.administeredProduct**: workflow=Event.code; w5=FiveWs.what[x]; v2=RXA-5; rim=.code; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
- **Immunization.manufacturer**: v2=RXA-17; rim=.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
- **Immunization.lotNumber**: v2=RXA-15; rim=.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
- **Immunization.expirationDate**: v2=RXA-16; rim=.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
- **Immunization.patient**: workflow=Event.subject; w5=FiveWs.subject; v2=PID-3; rim=.partipication[ttypeCode=].role
- **Immunization.encounter**: workflow=Event.encounter; w5=FiveWs.context; v2=PV1-19; rim=component->EncounterEvent
- **Immunization.supportingInformation**: w5=FiveWs.context
- **Immunization.occurrence[x]**: workflow=Event.occurrence[x]; w5=FiveWs.done[x]; v2=RXA-3; rim=.effectiveTime; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
- **Immunization.primarySource**: workflow=Event.reported; w5=FiveWs.source; v2=RXA-9; rim=immunization.uncertaintycode (if primary source=false, uncertainty=U)
- **Immunization.informationSource**: workflow=Event.reported; w5=FiveWs.source; v2=RXA-9; rim=.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)
- **Immunization.location**: workflow=Event.location; w5=FiveWs.where[x]; v2=RXA-27  (or RXA-11, deprecated as of v2.7); rim=.participation[typeCode=LOC].COCT_MT240000UV
- **Immunization.site**: v2=RXR-2; rim=observation.targetSiteCode; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
- **Immunization.route**: v2=RXR-1; rim=.routeCode; cda=ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
- **Immunization.doseQuantity**: v2=RXA-6 / RXA-7; rim=.doseQuantity
- **Immunization.performer**: workflow=Event.performer; v2=ORC-12 / RXA-10; rim=.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
- **Immunization.performer.function**: workflow=Event.performer.function; rim=.participation.functionCode
- **Immunization.performer.actor**: workflow=Event.performer.actor; w5=FiveWs.actor; rim=.player
- **Immunization.note**: workflow=Event.note; v2=OBX-5 : OBX-3 = 48767-8; rim=note
- **Immunization.reason**: workflow=Event.reason; rim=[actionNegationInd=false].reasonCode
- **Immunization.isSubpotent**: v2=RXA-20 = PA (partial administration); rim=N/A
- **Immunization.subpotentReason**: rim=N/A
- **Immunization.programEligibility**: v2=OBX-5 : OBX-3 = 64994-7; rim=n/a
- **Immunization.programEligibility.program**: rim=n/a
- **Immunization.programEligibility.programStatus**: rim=n/a
- **Immunization.fundingSource**: rim=N/A
- **Immunization.reaction**: v2=OBX-3; rim=Observation[classCode=obs].code
- **Immunization.reaction.date**: v2=OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 V2 VXU message - most likely would appear in OBX segments if at all); rim=.effectiveTime
- **Immunization.reaction.manifestation**: v2=OBX-5; rim=.value
- **Immunization.reaction.reported**: v2=(HL7 V2 doesn't seem to provide for this); rim=.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
- **Immunization.protocolApplied**: rim=N/A
- **Immunization.protocolApplied.series**: rim=N/A
- **Immunization.protocolApplied.authority**: rim=N/A
- **Immunization.protocolApplied.targetDisease**: rim=N/A
- **Immunization.protocolApplied.doseNumber**: rim=N/A
- **Immunization.protocolApplied.seriesDoses**: rim=N/A