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: VAERSPatient - Mappings

Draft as of 2025-06-13

Mappings for the VAERSPatient 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
Patient.identifier.value 0      
Patient.birthDate 2      
Patient.gender 3      
Patient.deceasedDateTime 21-7.1      
Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race].extension[ombCategory].valueCoding 24-7      
Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity].extension[ombCategory].valueCoding 25-4      

Raw Mappings

key status direction source mapApproach mapCase FHIR Path subPath mapValue mapParameter mapComment FHIR URL | Ver
1863 in process A2F ADERS - 0_Pt_ICN_Full (0) source value Patient.identifier .value .system=urn:oid:2.16.840.1.113883.4.349
.type.coding.code=#MR
.type.coding.system=http://terminology.hl7.org/CodeSystem/v2-0203		 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1874 in process A2F ADERS - 2_ptDOB (2) source value Patient.birthDate http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1880 in process A2F ADERS - 3_ptSex (3) source value Patient.gender http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
2022 in process A2F target not supported Patient.name because of must-support; FDA receives minimal deidentified data http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
2024 in process A2F target not supported Patient.address because of must-support; FDA receives minimal deidentified data http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
2025 in process A2F target not supported Patient.communication.language because of must-support; FDA receives minimal deidentified data http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1882 in process A2F ADERS - transform Patient.extension[http://va.gov/fhir/StructureDefinition/patient-ageAtVaccination].valueString concat(6_PtAgeVacYears, 6_PtAgeVacMonths) http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1917 in process A2F ADERS - 21_DeathDt (21-7.1) source value Patient.deceasedDateTime http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1948 in process A2F ADERS - 24_PtRace_AIAN (24-1) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" .extension[text].valueString=”AIAN” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1949 in process A2F ADERS - 24_PtRace_Asian (24-2) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" .extension[text].valueString=”Asian” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1950 in process A2F ADERS - 24_PtRace_BlkAM (24-3) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" .extension[text].valueString=”BlkAM” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1951 in process A2F ADERS - 24_PtRace_NH_OPI (24-4) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" .extension[text].valueString=”NH_OPI” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1952 in process A2F ADERS - 24_PtRace_White (24-5) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2106-3 "White" .extension[text].valueString=”White” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1953 in process A2F ADERS - 24_PtRace_Unk (24-6) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" .extension[text].valueString=”Unk” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1954 in process A2F ADERS - 24_PtRace_Other (24-7) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" .extension[text].valueString=”Other” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1955 in process A2F ADERS - 25_PtEthnicity_HispLat (25-1) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" .extension[text].valueString=”HispLat” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1956 in process A2F ADERS - 25_PtEthnicity_NHL (25-2) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] .extension[ombCategory].valueCoding urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" .extension[text].valueString=”NHL” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1957 in process A2F ADERS - 25_PtEthnicity_Unk (25-3) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] .extension[ombCategory].valueCoding http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" .extension[text].valueString=”Unk” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1
1958 in process A2F ADERS - 25_PtEthnicity_Other (25-4) fixed value not xsi:nil Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] .extension[ombCategory].valueCoding http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" .extension[text].valueString=”Other” http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 5.0.1

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

VAERSPatient
Patient
   extension
   extension (race)
      extension
      extension (ombCategory)
         value[x]1948: fixed value = urn:oid:2.16.840.1.113883.6.238#1002-5 "American Indian or Alaska Native" when ADERS - 24_PtRace_AIAN (24-1) if not xsi:nil, 1949: fixed value = urn:oid:2.16.840.1.113883.6.238#2028-9 "Asian" when ADERS - 24_PtRace_Asian (24-2) if not xsi:nil, 1950: fixed value = urn:oid:2.16.840.1.113883.6.238#2054-5 "Black or African American" when ADERS - 24_PtRace_BlkAM (24-3) if not xsi:nil, 1951: fixed value = urn:oid:2.16.840.1.113883.6.238#2076-8 "Native Hawaiian or Other Pacific Islander" when ADERS - 24_PtRace_NH_OPI (24-4) if not xsi:nil, 1952: fixed value = urn:oid:2.16.840.1.113883.6.238#2106-3 "White" when ADERS - 24_PtRace_White (24-5) if not xsi:nil, 1953: fixed value = http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" when ADERS - 24_PtRace_Unk (24-6) if not xsi:nil, 1954: fixed value = urn:oid:2.16.840.1.113883.6.238#2131-1 "Other Race" when ADERS - 24_PtRace_Other (24-7) if not xsi:nil, , , , , ,
      extension (detailed)
      extension (text)
         value[x]1948-1: fixed value = AIAN if not xsi:nil, 1949-1: fixed value = Asian if not xsi:nil, 1950-1: fixed value = BlkAM if not xsi:nil, 1951-1: fixed value = NH_OPI if not xsi:nil, 1952-1: fixed value = White if not xsi:nil, 1953-1: fixed value = Unk if not xsi:nil, 1954-1: fixed value = Other if not xsi:nil

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1
   extension (ethnicity)
      extension
      extension (ombCategory)
         value[x]1955: fixed value = urn:oid:2.16.840.1.113883.6.238#2135-2 "Hispanic or Latino" when ADERS - 25_PtEthnicity_HispLat (25-1) if not xsi:nil, 1956: fixed value = urn:oid:2.16.840.1.113883.6.238#2186-5 "Not Hispanic or Latino" when ADERS - 25_PtEthnicity_NHL (25-2) if not xsi:nil, 1957: fixed value = http://terminology.hl7.org/CodeSystem/v3-NullFlavor#UNK "unknown" when ADERS - 25_PtEthnicity_Unk (25-3) if not xsi:nil, 1958: fixed value = http://terminology.hl7.org/CodeSystem/v3-NullFlavor#OTH "other" when ADERS - 25_PtEthnicity_Other (25-4) if not xsi:nil, , ,
      extension (detailed)
      extension (text)
         value[x]1955-1: fixed value = HispLat if not xsi:nil, 1956-1: fixed value = NHL if not xsi:nil, 1957-1: fixed value = Unk if not xsi:nil, 1958-1: fixed value = Other if not xsi:nil

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1

,

generated from mapParameter line 1
   extension (birthsex)
   extension (genderIdentity)
   extension (patient-ageAtVaccination)
      value[x]1882: transform using concat(6_PtAgeVacYears, 6_PtAgeVacMonths)
   identifier
      type
         coding
            system1863-3: fixed value = http://terminology.hl7.org/CodeSystem/v2-0203

generated from mapParameter line 3
            code1863-2: fixed value = #MR

generated from mapParameter line 2
      system1863-1: fixed value = urn:oid:2.16.840.1.113883.4.349

generated from mapParameter line 1
      value1863: source value based on ADERS - 0_Pt_ICN_Full (0)
   name2022: target not supported

because of must-support; FDA receives minimal deidentified data
   gender1880: source value based on ADERS - 3_ptSex (3)
   birthDate1874: source value based on ADERS - 2_ptDOB (2)
   deceased[x] (deceasedDateTime)1917: source value based on ADERS - 21_DeathDt (21-7.1)
   address2024: target not supported

because of must-support; FDA receives minimal deidentified data
   communication
      language2025: target not supported

because of must-support; FDA receives minimal deidentified data

Mappings for Clinical Data Warehouse (CDW) ()

VAERSPatient
Patient
   extension
   extension (race)
      extension
      extension (ombCategory)
      extension (detailed)
      extension (text)
   extension (ethnicity)
      extension
      extension (ombCategory)
         value[x]Dim.DischargeType.DischargeTypeAbbreviation

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

VAERSPatient
PatientEntity. Role, or Act, Patient[classCode=PAT]
   textAct.text?
   containedN/A
   extension
   extension (race)
      idn/a
      extensionn/a
      extension (ombCategory)
         idn/a
         urlN/A
         value[x]N/A
      extension (detailed)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (text)
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (ethnicity)
      idn/a
      extensionn/a
      extension (ombCategory)
         idn/a
         urlN/A
         value[x]N/A
      extension (detailed)
         idn/a
         extensionn/a
         urlN/A
         value[x]N/A
      extension (text)
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (birthsex)player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
   extension (genderIdentity)
   extension (patient-ageAtVaccination)
      idn/a
      urlN/A
      value[x]N/A
   modifierExtensionN/A
   identifierid
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   activestatusCode
   namename
      idn/a
      extensionn/a
      useunique(./use)
      text./formatted
      family./part[partType = FAM]
      given./part[partType = GIV]
      prefix./part[partType = PFX]
      suffix./part[partType = SFX]
      period./usablePeriod[type="IVL<TS>"]
   telecomtelecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   genderplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
   birthDateplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
   deceased[x]player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
   deceased[x] (deceasedDateTime)player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
   addressaddr
      idn/a
      extensionn/a
      useunique(./use)
      typeunique(./use)
      text./formatted
      lineAD.part[parttype = AL]
      cityAD.part[parttype = CTY]
      districtAD.part[parttype = CNT | CPA]
      stateAD.part[parttype = STA]
      postalCodeAD.part[parttype = ZIP]
      countryAD.part[parttype = CNT]
      period./usablePeriod[type="IVL<TS>"]
   maritalStatusplayer[classCode=PSN]/maritalStatusCode
   multipleBirth[x]player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
   photoplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
   contactplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
      idn/a
      extensionn/a
      modifierExtensionN/A
      relationshipcode
      namename
      telecomtelecom
      addressaddr
      genderplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
      organizationscoper
      periodeffectiveTime
   communicationLanguageCommunication
      idn/a
      extensionn/a
      modifierExtensionN/A
      languageplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
      preferredpreferenceInd
   generalPractitionersubjectOf.CareEvent.performer.AssignedEntity
   managingOrganizationscoper
   linkoutboundLink
      idn/a
      extensionn/a
      modifierExtensionN/A
      otherid
      typetypeCode

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

VAERSPatient
PatientClinicalDocument.recordTarget.patientRole
   identifier.id
   activen/a
   name.patient.name
   telecom.telecom
   gender.patient.administrativeGenderCode
   birthDate.patient.birthTime
   deceased[x]n/a
   deceased[x] (deceasedDateTime)n/a
   address.addr
   maritalStatus.patient.maritalStatusCode
   multipleBirth[x]n/a
   photon/a
   contactn/a
      relationshipn/a
      namen/a
      telecomn/a
      addressn/a
      gendern/a
      organizationn/a
      periodn/a
   communicationpatient.languageCommunication
      language.languageCode
      preferred.preferenceInd
   generalPractitionern/a
   managingOrganization.providerOrganization
   linkn/a
      othern/a
      typen/a

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

VAERSPatient
Patient
   identifierFiveWs.identifier
   activeFiveWs.status

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

VAERSPatient
Patient
   identifierPID-3
      useN/A
      typeCX.5
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   namePID-5, PID-9
      useXPN.7, but often indicated by which field contains the name
      textimplied by XPN.11
      familyXPN.1/FN.1
      givenXPN.2 + XPN.3
      prefixXPN.5
      suffixXPN/4
      periodXPN.13 + XPN.14
   telecomPID-13, PID-14, PID-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   genderPID-8
   birthDatePID-7
   deceased[x]PID-30 (bool) and PID-29 (datetime)
   deceased[x] (deceasedDateTime)PID-30 (bool) and PID-29 (datetime)
   addressPID-11
      useXAD.7
      typeXAD.18
      textXAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
      lineXAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
      cityXAD.3
      districtXAD.9
      stateXAD.4
      postalCodeXAD.5
      countryXAD.6
      periodXAD.12 / XAD.13 + XAD.14
   maritalStatusPID-16
   multipleBirth[x]PID-24 (bool), PID-25 (integer)
   photoOBX-5 - needs a profile
   contact
      relationshipNK1-7, NK1-3
      nameNK1-2
      telecomNK1-5, NK1-6, NK1-40
      addressNK1-4
      genderNK1-15
      organizationNK1-13, NK1-30, NK1-31, NK1-32, NK1-41
   communication
      languagePID-15, LAN-2
      preferredPID-15
   generalPractitionerPD1-4
   link
      otherPID-3, MRG-1

Mappings for LOINC code for the element (http://loinc.org)

VAERSPatient
Patient
   birthDate21112-8