US Veterans Health Administration FHIR Map Set Implementation Guide
1.8.0 - 250901
US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.8.0 See the Directory of published versions
Active as of 2025-09-02 |
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 | Workflow Pattern | HL7 v2 Mapping | RIM Mapping | FiveWs Pattern Mapping | CDA (R2)![]() |
---|---|---|---|---|---|
![]() ![]() |
Event |
VXU_V04 |
SubstanceAdministration |
||
![]() ![]() ![]() |
|||||
![]() ![]() ![]() |
|||||
![]() ![]() ![]() |
|||||
![]() ![]() ![]() |
|||||
![]() ![]() ![]() |
Act.text? |
||||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() |
Event.identifier |
.id |
FiveWs.identifier |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id | |
![]() ![]() ![]() |
Event.status |
statusCode |
FiveWs.status |
||
![]() ![]() ![]() |
Event.statusReason |
|
|||
![]() ![]() ![]() |
Event.code |
RXA-5 |
.code |
FiveWs.what[x] |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code |
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
|
|
|||
![]() ![]() ![]() ![]() ![]() |
|
|
|||
![]() ![]() ![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.3 |
./codeSystem |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.7 |
./codeSystemVersion |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.1 |
./code |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.2 - but note this is not well followed |
CV.displayName |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
Sometimes implied by being first |
CD.codingRationale |
|||
![]() ![]() ![]() ![]() ![]() |
|
|
|||
![]() ![]() ![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.3 |
./codeSystem |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.7 |
./codeSystemVersion |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.1 |
./code |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
C*E.2 - but note this is not well followed |
CV.displayName |
|||
![]() ![]() ![]() ![]() ![]() ![]() |
Sometimes implied by being first |
CD.codingRationale |
|||
![]() ![]() ![]() ![]() |
C*E.9. But note many systems use C*E.2 for this |
./originalText[mediaType/code="text/plain"]/data |
|||
![]() ![]() ![]() |
Event.subject |
PID-3 |
.partipication[ttypeCode=].role |
FiveWs.subject |
|
![]() ![]() ![]() |
Event.context |
PV1-19 |
component->EncounterEvent |
FiveWs.context |
|
![]() ![]() ![]() |
Event.occurrence[x] |
RXA-3 |
.effectiveTime |
FiveWs.done[x] |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value |
![]() ![]() ![]() ![]() |
Event.occurrence[x] |
RXA-3 |
.effectiveTime |
FiveWs.done[x] |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value |
![]() ![]() ![]() |
.participation[typeCode=AUT].time |
FiveWs.recorded |
|||
![]() ![]() ![]() |
RXA-9 |
|
FiveWs.source |
||
![]() ![]() ![]() |
RXA-9 |
.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) |
FiveWs.source |
||
![]() ![]() ![]() |
Event.location |
|
.participation[typeCode=LOC].COCT_MT240000UV |
FiveWs.where[x] |
|
![]() ![]() ![]() |
RXA-17 |
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG] |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name | ||
![]() ![]() ![]() |
RXA-15 |
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText | ||
![]() ![]() ![]() |
RXA-16 |
.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime |
|||
![]() ![]() ![]() |
RXR-2 |
observation.targetSiteCode |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code | ||
![]() ![]() ![]() |
RXR-1 |
.routeCode |
ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code | ||
![]() ![]() ![]() |
RXA-6 / RXA-7 |
.doseQuantity |
|||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
SN.2 / CQ - N/A |
|
|||
![]() ![]() ![]() ![]() |
SN.1 / CQ.1 |
IVL properties |
|||
![]() ![]() ![]() ![]() |
(see OBX.6 etc.) / CQ.2 |
PQ.unit |
|||
![]() ![]() ![]() ![]() |
(see OBX.6 etc.) / CQ.2 |
|
|||
![]() ![]() ![]() ![]() |
(see OBX.6 etc.) / CQ.2 |
|
|||
![]() ![]() ![]() |
Event.performer |
ORC-12 / RXA-10 |
.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE] |
||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
Event.performer.function |
.participation.functionCode |
|||
![]() ![]() ![]() ![]() |
Event.performer.actor |
.player |
FiveWs.actor |
||
![]() ![]() ![]() |
Event.note |
OBX-3 = 48767-8 |
note |
||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
N/A |
Act.participant[typeCode=AUT].role |
|||
![]() ![]() ![]() ![]() |
N/A |
Act.effectiveTime |
|||
![]() ![]() ![]() ![]() |
N/A |
Act.text |
|||
![]() ![]() ![]() |
Event.reasonCode |
[actionNegationInd=false].reasonCode |
|||
![]() ![]() ![]() |
Event.reasonReference |
N/A |
|||
![]() ![]() ![]() |
RXA-20 = PA (partial administration) |
N/A |
|||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
OBX-3 = 69764-9 |
N/A |
|||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
OBX-3 = 29768-9 |
N/A |
|||
![]() ![]() ![]() ![]() |
OBX-3 = 29769-7 |
N/A |
|||
![]() ![]() ![]() |
OBX-3 = 64994-7 |
N/A |
|||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() |
OBX-3 |
Observation[classCode=obs].code |
|||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
|
.effectiveTime |
|||
![]() ![]() ![]() ![]() |
OBX-5 |
.value |
|||
![]() ![]() ![]() ![]() |
(HL7 v2 doesn't seem to provide for this) |
.participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true) |
|||
![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
n/a |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() ![]() |
N/A |
||||
![]() ![]() ![]() ![]() |
N/A |
||||
![]() |