US Veterans Health Administration FHIR Map Set Implementation Guide
1.9.0 - 251001
US Veterans Health Administration FHIR Map Set Implementation Guide
1.9.0 - 251001
US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.9.0 See the Directory of published versions
| Active as of 2025-09-30 |
Mappings for the ImmunizationImmunization 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.
| key | status | direction | source | mapApproach | mapCase | FHIR Path | subPath | mapValue | mapParameter | mapComment | FHIR URL | Ver |
|---|---|---|---|---|---|---|---|---|---|---|---|
| 527 | team-approved | V2F | V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) | terminologyMaps | V IMMUNIZATION - IMMUNIZATION null | Immunization.statusReason | VF_immunizationStatusReason | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |||
| 528 | team-approved | V2F | V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) | terminologyMaps | V IMMUNIZATION - IMMUNIZATION null | Immunization.vaccineCode | VF_inferredCVX | This map is used to identify CVX codes for immunizations that were not given, and which therefore are not coded. The name can be used to determine what the CVX Group. | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||
| 607 | team-approved | V2F | V IMMUNIZATION - EVENT INFORMATION SOURCE (9000010.11-1301) | transform | Immunization.primarySource | VF_immunizationPrimarySource | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 297 | team-approved | V2F | V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - CVX CODE (9000010.11-.01 > 9999999.14-.03) | fixed value | CVX populated | Immunization.status | #completed | subfile: .03 is CVX | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||
| 298 | team-approved | V2F | V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) | exclude record | missing or unknown | Immunization.status | subfile: .01 is text | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |||
| 299 | team-approved | V2F | V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) | fixed value | text like 'contraindicated', 'refused', 'decline', 'not avail' | Immunization.status | #not-done | subfile: .01 is text | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||
| 332 | team-approved | V2F | V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - CVX CODE (9000010.11-.01 > 9999999.14-.03) | source value | not null | Immunization.vaccineCode | .coding[va-cvx].code | .text={NAME (.01)} .coding[va-cvx].system = http://hl7.org/fhir/sid/cvx |
subfile: .03 is CVX | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |
| 333 | team-approved | V2F | V IMMUNIZATION - PATIENT NAME > PATIENT/IHS - NAME (9000010.11-.02 > 9000001-.01) | reference | Immunization.patient | /Patient | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 334 | team-approved | V2F | V IMMUNIZATION - EVENT DATE AND TIME (9000010.11-1201) | source value | Immunization.occurrenceDateTime | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |||||
| 338 | team-approved | V2F | V IMMUNIZATION - LOT > IMMUNIZATION LOT - LOT NUMBER (9000010.11-.05 > 9999999.41-.01) | source value | Immunization.lotNumber | pointer to subfile 9999999.04-.02 MVX code, 9999999.04-.01 lot | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 339 | team-approved | V2F | V IMMUNIZATION - LOT > IMMUNIZATION LOT - MANUFACTURER (9000010.11-.05 > 9999999.41-.02) | source value | Immunization.manufacturer | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |||||
| 1609 | for review | V2F | V IMMUNIZATION - LOT > IMMUNIZATION LOT - NDC CODE (VA) (9000010.11-.05 > 9999999.41-.18) | source value | Immunization.vaccineCode.coding[va-ndc] | .code | .system = http://hl7.org/fhir/sid/ndc | constrains in us-core profile requires ndc as translation | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||
| 340 | team-approved | V2F | V IMMUNIZATION - DOSE (9000010.11-1312) | source value | Immunization.doseQuantity | .value | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 342 | team-approved | V2F | V IMMUNIZATION - ENCOUNTER PROVIDER (9000010.11-1204) | reference | Immunization.performer | .actor | /Practitioner | .function = http://terminology.hl7.org/CodeSystem/v2-0443#AP | instantiate with function or reference.display? | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |
| 343 | team-approved | V2F | V IMMUNIZATION - COMMENTS (9000010.11-81101) | source value | Immunization.note | .text | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 344 | team-approved | V2F | V IMMUNIZATION - SERIES (9000010.11-.04) | source value | Immunization.protocolApplied.doseNumberString | Can be numeral or letter | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 464 | for review | V2F | V IMMUNIZATION - DOSE UNITS > UCUM CODES - (9000010.11-1313 > 757.5-) | source value | Immunization.doseQuantity | .unit = {DESCRIPTION OF THE UNIT (.01)} .code= {UCUM CODE (1)} |
http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 1593 | for review | V2F | V IMMUNIZATION - DATE/TIME RECORDED (9000010.11-1205) | source value | Immunization.recorded | identified byMHV | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 1673 | for review | V2F | reference | Immunization.reaction.detail | Observation | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | |||||
| 1767 | for review | V2F | V IMMUNIZATION - VISIT (9000010.11-.03) | reference | Immunization.encounter | /EncounterOutpatient | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 | ||||
| 1801 | for review | V2F | V IMMUNIZATION - VISIT > VISIT - HOSPITAL LOCATION (9000010.11-.03 > 9000010-.22) | reference | Immunization.location | /Location | Added based on LH gap analysis; existed in PHAPI, not CoP maps | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | 5.0.1 |
No Mappings Found
No Mappings Found
| Name | Veterans Health Information Systems Technology and Architecture (VistA) | Clinical Data Warehouse (CDW) | Summary Document Architecure (SDA) | Virtual Patient Record XML (VPR) | Workflow Pattern |
|---|---|---|---|---|---|
  Immunization |
Event | ||||
  id |
|||||
 meta |
|||||
| implicitRules |
|||||
| language |
|||||
| text |
|||||
| contained |
|||||
 extension |
|||||
 modifierExtension |
|||||
| identifier |
Event.identifier | ||||
| status |
|
Immun.Immunization.ImmunizationNameIEN
Dim.ImmunizationName.ImmunizationName
Dim.PharmacyOrderableItem.ImmunizationName |
Vaccination.MaxDoseQuantity
Vaccination.OrderItem
Vaccination.Extension[VaccinationExtension].CDCName
Vaccination.Extension[VaccinationExtension].Source
Vaccination.AdministrationSite.Description
Vaccination.Manufacturer[VA.Manufacturer].Description
Vaccination.OrderItem[Order].Description
Vaccination.Route.Description
Vaccination.OrderItem[Order].Description
Vaccination.ObservationCodedValue[ObservationValueCode].Description |
immunization.cvx (>9999999.14-.03)
immunization.name (>9999999.14-.01) |
Event.status |
| statusReason |
terminologyMaps using VF_immunizationStatusReason on V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) if V IMMUNIZATION - IMMUNIZATION null |
Immun.Immunization.ImmunizationNameIEN
Dim.ImmunizationName.ImmunizationName
Dim.PharmacyOrderableItem.ImmunizationName |
Vaccination.MaxDoseQuantity
Vaccination.OrderItem
Vaccination.Extension[VaccinationExtension].CDCName
Vaccination.Extension[VaccinationExtension].Source
Vaccination.AdministrationSite.Description
Vaccination.Manufacturer[VA.Manufacturer].Description
Vaccination.OrderItem[Order].Description
Vaccination.Route.Description
Vaccination.OrderItem[Order].Description
Vaccination.ObservationCodedValue[ObservationValueCode].Description |
immunization.cvx (>9999999.14-.03)
immunization.name (>9999999.14-.01) |
Event.statusReason |
 vaccineCode |
terminologyMaps using VF_inferredCVX on V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) if V IMMUNIZATION - IMMUNIZATION null This map is used to identify CVX codes for immunizations that were not given, and which therefore are not coded. The name can be used to determine what the CVX Group. |
Immun.Immunization.ImmunizationNameIEN
Dim.ImmunizationName.ImmunizationName
Dim.PharmacyOrderableItem.ImmunizationName |
Vaccination.MaxDoseQuantity
Vaccination.OrderItem
Vaccination.Extension[VaccinationExtension].CDCName
Vaccination.Extension[VaccinationExtension].Source
Vaccination.AdministrationSite.Description
Vaccination.Manufacturer[VA.Manufacturer].Description
Vaccination.OrderItem[Order].Description
Vaccination.Route.Description
Vaccination.OrderItem[Order].Description
Vaccination.ObservationCodedValue[ObservationValueCode].Description |
immunization.cvx (>9999999.14-.03)
immunization.name (>9999999.14-.01) |
Event.code |
 id |
|||||
| extension |
|||||
 Slices for coding |
|||||
  coding:va-cvx |
|||||
  id |
|||||
| extension |
|||||
| system |
fixed value = http://hl7.org/fhir/sid/cvx if not null mapParameter line 2 |
||||
| version |
|||||
| code |
source value based on V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - CVX CODE (9000010.11-.01 > 9999999.14-.03) if not null subfile: .03 is CVX |
Immun.Immunization.ImmunizationNameIEN
Dim.ImmunizationName.CVXCode |
Vaccination.MaxDoseQuantity
Vaccination.OrderItem
Vaccination.Extension[VaccinationExtension].CDCName
Vaccination.Extension[VaccinationExtension].Source
Vaccination.AdministrationSite.Description
Vaccination.Manufacturer[VA.Manufacturer].Description
Vaccination.OrderItem[Order].Code
Vaccination.Route.Code
Vaccination.OrderItem[Order].Code |
immunization.cvx (>9999999.14-.03)
immunization.name (>9999999.14-.01) |
|
| display |
|||||
 userSelected |
|||||
 coding:va-ndc |
|||||
 id |
|||||
| extension |
|||||
| system |
fixed value = http://hl7.org/fhir/sid/ndc mapParameter line 1 |
||||
| version |
|||||
| code |
source value based on V IMMUNIZATION - LOT > IMMUNIZATION LOT - NDC CODE (VA) (9000010.11-.05 > 9999999.41-.18) constrains in us-core profile requires ndc as translation |
Dim.ImmunizationLot.NDCCodeVAText |
|||
| display |
|||||
| userSelected |
|||||
 text |
source value based on V IMMUNIZATION - IMMUNIZATION > IMMUNIZATION - NAME (9000010.11-.01 > 9999999.14-.01) if not null mapParameter line 1 |
Immun.Immunization.ImmunizationNameIEN
Dim.ImmunizationName.ImmunizationName
Dim.PharmacyOrderableItem.ImmunizationName |
Vaccination.MaxDoseQuantity
Vaccination.OrderItem
Vaccination.Extension[VaccinationExtension].CDCName
Vaccination.Extension[VaccinationExtension].Source
Vaccination.AdministrationSite.Description
Vaccination.Manufacturer[VA.Manufacturer].Description
Vaccination.OrderItem[Order].Description
Vaccination.Route.Description
Vaccination.OrderItem[Order].Description
Vaccination.ObservationCodedValue[ObservationValueCode].Description |
immunization.cvx (>9999999.14-.03)
immunization.name (>9999999.14-.01) |
|
 patient |
reference based on V IMMUNIZATION - PATIENT NAME > PATIENT/IHS - NAME (9000010.11-.02 > 9000001-.01) |
Immun.Immunization.PatientIEN |
Vaccination.AdministrationSite.Code
Vaccination.Manufacturer[VA.Manufacturer].Code |
Event.subject | |
| encounter |
reference based on V IMMUNIZATION - VISIT (9000010.11-.03) |
Immun.Immunization.OutsideLocation
Immun.Immunization.VisitDateTime
Immun.Immunization.VisitIEN |
Vaccination.EncounterNumber
Vaccination.EnteredAt
Vaccination.Administration.AdministeredAtLocation |
immunization.administered
immunization.encounter
immunization.facility (>9000010-.06)
immunization.location (>9000010-.22) |
Event.context |
| Slices for occurrence[x] |
Event.occurrence[x] | ||||
 occurrence[x]:occurrenceDateTime |
source value based on V IMMUNIZATION - EVENT DATE AND TIME (9000010.11-1201) |
Immun.Immunization.EventDateTime |
Vaccination.FromTime
Vaccination.ToTime |
Event.occurrence[x] | |
| recorded |
source value based on V IMMUNIZATION - DATE/TIME RECORDED (9000010.11-1205) identified byMHV |
Immun.Immunization.RecordedDateTime |
|||
| primarySource |
transform using VF_immunizationPrimarySource on V IMMUNIZATION - EVENT INFORMATION SOURCE (9000010.11-1301) |
Immun.Immunization.ImmunizationInformationSourceIEN |
Vaccination.Extension[VaccinationExtension].Source |
immunization.source (>920.1-.01)
immunization.source (>920.1-.02) |
|
| reportOrigin |
|||||
| location |
reference based on V IMMUNIZATION - VISIT > VISIT - HOSPITAL LOCATION (9000010.11-.03 > 9000010-.22) Added based on LH gap analysis; existed in PHAPI, not CoP maps |
Immun.Immunization.OutsideLocation
Immun.Immunization.VisitDateTime
Immun.Immunization.VisitIEN
Outpat.Visit.LocationIEN
Outpat.Workload.LocationIEN |
Vaccination.EncounterNumber
Vaccination.EnteredAt
Vaccination.Administration.AdministeredAtLocation
Encounter.ExternalId
Encounter.HealthCareFacility |
immunization.administered
immunization.encounter
immunization.facility (>9000010-.06)
immunization.location (>9000010-.22)
visit.creditStopCode (>44-2503)
visit.location (>44-.01)
visit.visitString |
Event.location |
| manufacturer |
source value based on V IMMUNIZATION - LOT > IMMUNIZATION LOT - MANUFACTURER (9000010.11-.05 > 9999999.41-.02) |
Dim.ImmunizationLot.ImmunizationManufacturerIEN
Dim.ImmunizationLot.ImmunizationManufacturerSID |
|||
| lotNumber |
source value based on V IMMUNIZATION - LOT > IMMUNIZATION LOT - LOT NUMBER (9000010.11-.05 > 9999999.41-.01) pointer to subfile 9999999.04-.02 MVX code, 9999999.04-.01 lot |
Dim.ImmunizationLot.ImmunizationLot |
|||
| expirationDate |
|||||
| site |
|||||
| route |
|||||
| doseQuantity |
source value based on V IMMUNIZATION - DOSE UNITS > UCUM CODES - (9000010.11-1313 > 757.5-) |
Immun.Immunization.DoseUnit |
Vaccination.Administration.AdministeredUnits |
||
| id |
|||||
| extension |
|||||
| value |
source value based on V IMMUNIZATION - DOSE (9000010.11-1312) |
Immun.Immunization.Dosage |
Vaccination.Administration.AdministeredAmount |
immunization.dose |
|
| comparator |
|||||
| unit |
source value based on V IMMUNIZATION - DOSE UNITS > UCUM CODES - DESCRIPTION OF THE UNIT (9000010.11-1313 > 757.5-.01) mapParameter line 1 |
Immun.Immunization.DoseUnit
Dim.UCUMCode.DescriptionOfTheUnit |
Vaccination.Administration.AdministeredUnits |
||
| system |
|||||
| code |
source value based on V IMMUNIZATION - DOSE UNITS > UCUM CODES - UCUM CODE (9000010.11-1313 > 757.5-1) mapParameter line 2 |
Immun.Immunization.DoseUnit
Dim.UCUMCode.UCUMCode |
Vaccination.Administration.AdministeredUnits |
||
| performer |
Event.performer | ||||
| id |
|||||
| extension |
|||||
| modifierExtension |
|||||
| function |
fixed value = http://terminology.hl7.org/CodeSystem/v2-0443#AP mapParameter line 1 |
Event.performer.function | |||
| actor |
reference based on V IMMUNIZATION - ENCOUNTER PROVIDER (9000010.11-1204) instantiate with function or reference.display? |
Immun.Immunization.ImmunizingStaffIEN |
Vaccination.Administration.AdministeringProvider |
immunization.provider (>200-.01) |
Event.performer.actor |
| note |
Event.note | ||||
| id |
|||||
| extension |
|||||
 author[x] |
|||||
| time |
|||||
| text |
source value based on V IMMUNIZATION - COMMENTS (9000010.11-81101) |
Immun.Immunization.ImmunizationComments |
Vaccination.Comments |
immunization.comment |
|
| reasonCode |
Event.reasonCode | ||||
| reasonReference |
Event.reasonReference | ||||
| isSubpotent |
|||||
| subpotentReason |
|||||
| education |
|||||
| id |
|||||
| extension |
|||||
| modifierExtension |
|||||
| documentType |
|||||
| reference |
|||||
| publicationDate |
|||||
| presentationDate |
|||||
| programEligibility |
|||||
| fundingSource |
|||||
| reaction |
|||||
| id |
|||||
| extension |
|||||
| modifierExtension |
|||||
| date |
|||||
| detail |
reference |
||||
| reported |
|||||
 protocolApplied |
|||||
| id |
|||||
| extension |
|||||
| modifierExtension |
|||||
| series |
|||||
| authority |
|||||
| targetDisease |
|||||
| Slices for doseNumber[x] |
|||||
| doseNumber[x]:doseNumberString |
source value based on V IMMUNIZATION - SERIES (9000010.11-.04) Can be numeral or letter |
Immun.Immunization.Series |
Vaccination.Administration.AdministrationStatus |
immunization.series |
|
| seriesDoses[x] |
|||||
| Documentation for this format | |||||