US Veterans Health Administration FHIR Map Set Implementation Guide
1.6.49 - 250701 United States of America flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: VAERSImmunizationvac3 - Mappings

Draft as of 2025-06-13

Mappings for the VAERSImmunizationvac3 resource profile.

Scroll down for the Raw FHIR, CDW & SDA mappings (if any).

Note that the CDW, SDA and VPR XML mappings are derived from a look-up based on the VistA source.

Mapping Sources

Use Case: VAERS (Source)Use Case: VAERS (Source)ADERS (0)00_Pt_ICN_FullADERS (2)22_ptDOBADERS (3)33_ptSexADERS (17)1.117_Vac1_TypeBrand1.217_Vac1_Mfgr1.317_Vac1_Lot1.417_Vac1_Route1.517_Vac1_Site1.617_Vac1_DoseInSeries2.117_Vac2_TypeBrand2.217_Vac2_Mfgr2.317_Vac2_Lot2.417_Vac2_Route2.517_Vac2_Site2.617_Vac2_DoseInSeries3.117_Vac3_TypeBrand3.217_Vac3_Mfgr3.317_Vac3_Lot3.417_Vac3_Route3.517_Vac3_Site3.617_Vac3_DoseInSeries4.117_Vac4_TypeBrand4.217_Vac4_Mfgr4.317_Vac4_Lot4.417_Vac4_Route4.517_Vac4_Site4.617_Vac4_DoseInSeriesADERS (18)1818_VAE_DescADERS (21)121_VAE_Outcome_DrVisit221_VAE_Outcome_ErED321_HospStay421_ProlongHospStay521_LTI621_Dis721_Death7.121_DeathDt821_CA_BD921_NOAADERS (22)1.122_PVac1_TypeBrand1.222_PVac1_Mfgr1.322_PVac1_Lot1.422_PVac1_Route1.522_PVac1_Site1.622_PVac1_DoseInSeries1.722_PVac1_Date2.122_PVac2_TypeBrand2.222_PVac2_Mfgr2.322_PVac2_Lot2.422_PVac2_Route2.522_PVac2_Site2.622_PVac2_DoseInSeries2.722_PVac2_Date3.122_PVac3_TypeBrand3.222_PVac3_Mfgr3.322_PVac3_Lot3.422_PVac3_Route3.522_PVac3_Site3.622_PVac3_DoseInSeries3.722_PVac3_Date4.122_PVac4_TypeBrand4.222_PVac4_Mfgr4.322_PVac4_Lot4.422_PVac4_Route4.522_PVac4_Site4.622_PVac4_DoseInSeries4.722_PVac4_DateADERS (24)124_PtRace_AIAN224_PtRace_Asian324_PtRace_BlkAM424_PtRace_NH_OPI524_PtRace_White624_PtRace_Unk724_PtRace_OtherADERS (25)125_PtEthnicity_HispLat225_PtEthnicity_NHL325_PtEthnicity_Unk425_PtEthnicity_Other

Cross Mappings

FHIR Path VistA CDW SDA VPR
Immunization.vaccineCode 17-3.1      
Immunization.manufacturer.display 17-3.2      
Immunization.lotNumber 17-3.3      
Immunization.route 17-3.4      
Immunization.site 17-3.5      
Immunization.protocolApplied.doseNumberString 17-3.6      
Immunization.patient 0      

Raw Mappings

key status direction source mapApproach mapCase FHIR Path subPath mapValue mapParameter mapComment FHIR URL | Ver
2020 in process A2F target not supported Immunization[vac3].occurrenceDateTime http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1893 in process A2F ADERS - 17_Vac3_TypeBrand (17-3.1) source value Immunization[vac3].vaccineCode http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1894 in process A2F ADERS - 17_Vac3_Mfgr (17-3.2) source value Immunization[vac3].manufacturer.display http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1895 in process A2F ADERS - 17_Vac3_Lot (17-3.3) source value Immunization[vac3].lotNumber http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1896 in process A2F ADERS - 17_Vac3_Route (17-3.4) source value Immunization[vac3].route http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1897 in process A2F ADERS - 17_Vac3_Site (17-3.5) source value Immunization[vac3].site http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1898 in process A2F ADERS - 17_Vac3_DoseInSeries (17-3.6) source value Immunization[vac3].protocolApplied.doseNumberString http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
1876 in process A2F ADERS - 0_Pt_ICN_Full (0) reference Immunization.patient /VAERSPatient http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
2026 in process A2F fixed value Immunization.status #completed because of must-support http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
2027 in process A2F target not supported Immunization.statusReason because of must-support: assume done http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1
2028 in process A2F fixed value Immunization.primarySource false because of must-support http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1

Mappings for VA Adverse Drug Event Reporting System (VA ADERS) ()

VAERSImmunizationvac3
Immunization
   status2026: fixed value = #completed

because of must-support

   statusReason2027: target not supported

because of must-support: assume done

   vaccineCode1893: source value based on ADERS - 17_Vac3_TypeBrand (17-3.1)
   patient1876: reference based on ADERS - 0_Pt_ICN_Full (0)
   occurrence[x] (occurrenceDateTime)2020: target not supported
   primarySource2028: fixed value = false

because of must-support

   manufacturer
      display1894: source value based on ADERS - 17_Vac3_Mfgr (17-3.2)
   lotNumber1895: source value based on ADERS - 17_Vac3_Lot (17-3.3)
   site1897: source value based on ADERS - 17_Vac3_Site (17-3.5)
   route1896: source value based on ADERS - 17_Vac3_Route (17-3.4)
   protocolApplied
      doseNumber[x] (doseNumberString)1898: source value based on ADERS - 17_Vac3_DoseInSeries (17-3.6)

Mappings for Workflow Pattern (http://hl7.org/fhir/workflow)

VAERSImmunizationvac3
ImmunizationEvent
   identifierEvent.identifier
   statusEvent.status
   statusReasonEvent.statusReason
   vaccineCodeEvent.code
   patientEvent.subject
   encounterEvent.context
   occurrence[x]Event.occurrence[x]
   occurrence[x] (occurrenceDateTime)Event.occurrence[x]
   locationEvent.location
   performerEvent.performer
      functionEvent.performer.function
      actorEvent.performer.actor
   noteEvent.note
   reasonCodeEvent.reasonCode
   reasonReferenceEvent.reasonReference

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

VAERSImmunizationvac3
ImmunizationVXU_V04
   vaccineCodeRXA-5
   patientPID-3
   encounterPV1-19
   occurrence[x]RXA-3
   occurrence[x] (occurrenceDateTime)RXA-3
   primarySourceRXA-9
   reportOriginRXA-9
   locationRXA-27 (or RXA-11, deprecated as of v2.7)
   manufacturerRXA-17
   lotNumberRXA-15
   expirationDateRXA-16
   siteRXR-2
   routeRXR-1
   doseQuantityRXA-6 / RXA-7
   performerORC-12 / RXA-10
   noteOBX-5 : OBX-3 = 48767-8
   isSubpotentRXA-20 = PA (partial administration)
   education
      documentTypeOBX-5 : OBX-3 = 69764-9
      publicationDateOBX-5 : OBX-3 = 29768-9
      presentationDateOBX-5 : OBX-3 = 29769-7
   programEligibilityOBX-5 : OBX-3 = 64994-7
   reactionOBX-3
      dateOBX-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)
      detailOBX-5
      reported(HL7 v2 doesn't seem to provide for this)

Mappings for RIM Mapping (http://hl7.org/v3)

VAERSImmunizationvac3
ImmunizationEntity. Role, or Act, SubstanceAdministration
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   statusReason.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
   vaccineCode.code
   patient.partipication[ttypeCode=].role
   encountercomponent->EncounterEvent
   occurrence[x].effectiveTime
   occurrence[x] (occurrenceDateTime).effectiveTime
   recorded.participation[typeCode=AUT].time
   primarySourceimmunization.uncertaintycode (if primary source=false, uncertainty=U)
   reportOrigin.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)
   location.participation[typeCode=LOC].COCT_MT240000UV
   manufacturer.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
      displayN/A
   lotNumber.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
   expirationDate.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
   siteobservation.targetSiteCode
   route.routeCode
   doseQuantity.doseQuantity
   performer.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      function.participation.functionCode
      actor.player
   notenote
   reasonCode[actionNegationInd=false].reasonCode
   reasonReferenceN/A
   isSubpotentN/A
   subpotentReasonN/A
   educationN/A
      idn/a
      extensionn/a
      modifierExtensionN/A
      documentTypeN/A
      referenceN/A
      publicationDateN/A
      presentationDateN/A
   programEligibilityN/A
   fundingSourceN/A
   reactionObservation[classCode=obs].code
      idn/a
      extensionn/a
      modifierExtensionN/A
      date.effectiveTime
      detail.value
      reported.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
   protocolAppliedN/A
      idn/a
      extensionn/a
      modifierExtensionN/A
      seriesN/A
      authorityN/A
      targetDiseaseN/A
      doseNumber[x]N/A
      doseNumber[x] (doseNumberString)N/A
      seriesDoses[x]N/A

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

VAERSImmunizationvac3
Immunization
   identifierFiveWs.identifier
   statusFiveWs.status
   vaccineCodeFiveWs.what[x]
   patientFiveWs.subject[x], FiveWs.subject
   encounterFiveWs.context
   occurrence[x]FiveWs.done[x]
   occurrence[x] (occurrenceDateTime)FiveWs.done[x]
   recordedFiveWs.recorded
   primarySourceFiveWs.source
   reportOriginFiveWs.source
   locationFiveWs.where[x]
   performer
      actorFiveWs.actor

Mappings for CDA (R2) (http://hl7.org/v3/cda)

VAERSImmunizationvac3
Immunization
   identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
   vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
   occurrence[x]ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
   occurrence[x] (occurrenceDateTime)ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
   manufacturerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
   lotNumberClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
   siteClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
   routeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code