US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401 United States of America flag

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

Resource Profile: ImmunizationObservation - Mappings

Active as of 2025-03-31

Mappings for the ImmunizationObservation resource profile.

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

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

Mapping Sources

Use Case: Immunization (Source)PATIENT/IHS (9000001).01NAMEVISIT (9000010).22HOSPITAL LOCATIONV IMMUNIZATION (9000010.11).01IMMUNIZATION.02PATIENT NAME.03VISIT.04SERIES.05LOT.06REACTION1201EVENT DATE AND TIME1204ENCOUNTER PROVIDER1205DATE/TIME RECORDED1301EVENT INFORMATION SOURCE1312DOSE1313DOSE UNITS81101COMMENTSIMMUNIZATION (9999999.14).01NAME.03CVX CODEIMMUNIZATION LOT (9999999.41).01LOT NUMBER.02MANUFACTURER.18NDC CODE (VA)UCUM CODES (757.5).01DESCRIPTION OF THE UNIT1UCUM CODE[V IMMUNIZATION - IMMUNIZATION null][CVX populated][missing or unknown][text like 'contraindicated', 'refused', 'decline', 'not avail'][not null]

Raw Mappings

key status direction source mapApproach mapCase FHIR Path subPath mapValue mapParameter mapComment FHIR URL | Ver
1674 for review V2F fixed value Observation.status #completed http://hl7.org/fhir/StructureDefinition/Observation | 4.0.1
1675 for review V2F fixed value Observation.code http://loinc.org#31044-1 http://hl7.org/fhir/StructureDefinition/Observation | 4.0.1
1594 for review V2F V IMMUNIZATION - REACTION (9000010.11-.06) terminologyMaps Observation.valueCodeableConcept VF_ImmunizationReaction identified byMHV http://hl7.org/fhir/StructureDefinition/Observation | 4.0.1
1595 for review V2F V IMMUNIZATION - REACTION (9000010.11-.06) source value Observation.valueCodeableConcept .coding.code .coding.system = http://va.gov/terminology/vistaDefinedTerms/9000010.11-.06 identified byMHV http://hl7.org/fhir/StructureDefinition/Observation | 4.0.1
1595-1 for review V2F fixed value Observation.valueCodeableConcept .coding.system http://va.gov/terminology/vistaDefinedTerms/9000010.11-.06 generated from mapParameter line 1 http://hl7.org/fhir/StructureDefinition/Observation | 4.0.1
1596 for review V2F V IMMUNIZATION - REACTION (9000010.11-.06) source value Observation.valueCodeableConcept.text VA.gov recommends not using this; use AE data if necessary. Need identified by MHV for alignment with historical presentation. http://hl7.org/fhir/StructureDefinition/Observation | 4.0.1

Mappings for Veterans Health Information Systems Technology and Architecture (VistA) ()

ImmunizationObservation
Observation
   status1674: fixed value = #completed
   code1675: fixed value = http://loinc.org#31044-1
   value[x]
   value[x] (valueCodeableConcept)1594: terminologyMaps using VF_ImmunizationReaction on V IMMUNIZATION - REACTION (9000010.11-.06)

identified byMHV

      coding
         system1595-1: fixed value = http://va.gov/terminology/vistaDefinedTerms/9000010.11-.06

generated from mapParameter line 1

         code1595: source value based on V IMMUNIZATION - REACTION (9000010.11-.06)

identified byMHV

      text1596: source value based on V IMMUNIZATION - REACTION (9000010.11-.06)

VA.gov recommends not using this; use AE data if necessary. Need identified by MHV for alignment with historical presentation.

Mappings for Clinical Data Warehouse (CDW) ()

ImmunizationObservation
Observation
   value[x]
   value[x] (valueCodeableConcept)Immun.Immunization.Reaction
      coding
         codeImmun.Immunization.Reaction
      textImmun.Immunization.Reaction

Mappings for Summary Document Architecure (SDA) ()

ImmunizationObservation
Observation
   value[x]
   value[x] (valueCodeableConcept)Vaccination.Extension[VaccinationExtension].Reaction
      coding
         codeVaccination.Extension[VaccinationExtension].Reaction
      textVaccination.Extension[VaccinationExtension].Reaction

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

ImmunizationObservation
ObservationEvent
   identifierEvent.identifier
   basedOnEvent.basedOn
   partOfEvent.partOf
   statusEvent.status
   codeEvent.code
   subjectEvent.subject
   encounterEvent.context
   effective[x]Event.occurrence[x]
   performerEvent.performer.actor

Mappings for SNOMED CT Concept Domain Binding (http://snomed.info/conceptdomain)

ImmunizationObservation
Observation< 363787002 |Observable entity|
   status< 445584004 |Report by finality status|
   code< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
   value[x]< 441742003 |Evaluation finding|
   value[x] (valueCodeableConcept)< 441742003 |Evaluation finding|
   interpretation< 260245000 |Findings values|
   bodySite< 123037004 |Body structure|
   specimen< 123038009 |Specimen|
   device< 49062001 |Device|
   referenceRange
      type< 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
      appliesTo< 260245000 |Findings values| OR < 365860008 |General clinical state finding| OR < 250171008 |Clinical history or observation findings| OR < 415229000 |Racial group| OR < 365400002 |Finding of puberty stage| OR < 443938003 |Procedure carried out on subject|
   component
      code< 363787002 |Observable entity| OR < 386053000 |Evaluation procedure|
      value[x]363714003 |Interprets| < 441742003 |Evaluation finding|
      interpretation< 260245000 |Findings values|

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

ImmunizationObservation
ObservationOBX
   identifierOBX.21 For OBX segments from systems without OBX-21 support a combination of ORC/OBR and OBX must be negotiated between trading partners to uniquely identify the OBX segment. Depending on how V2 has been implemented each of these may be an option: 1) OBR-3 + OBX-3 + OBX-4 or 2) OBR-3 + OBR-4 + OBX-3 + OBX-4 or 2) some other way to uniquely ID the OBR/ORC + OBX-3 + OBX-4.
   basedOnORC
   partOfVaries by domain
   statusOBX-11
   codeOBX-3
   subjectPID-3
   focusOBX-3
   encounterPV1
   effective[x]OBX-14, and/or OBX-19 after v2.4 (depends on who observation made)
   issuedOBR.22 (or MSH.7), or perhaps OBX-19 (depends on who observation made)
   performerOBX.15 / (Practitioner) OBX-16, PRT-5:PRT-4='RO' / (Device) OBX-18 , PRT-10:PRT-4='EQUIP' / (Organization) OBX-23, PRT-8:PRT-4='PO'
   value[x]OBX.2, OBX.5, OBX.6
   value[x] (valueCodeableConcept)OBX.2, OBX.5, OBX.6
      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
   dataAbsentReasonN/A
   interpretationOBX-8
   noteNTE.3 (partner NTE to OBX, or sometimes another (child?) OBX)
   bodySiteOBX-20
   methodOBX-17
   specimenSPM segment
   deviceOBX-17 / PRT -10
   referenceRangeOBX.7
      lowOBX-7
      highOBX-7
      typeOBX-10
      appliesToOBX-10
      textOBX-7
   hasMemberRelationships established by OBX-4 usage
   derivedFromRelationships established by OBX-4 usage
   componentcontainment by OBX-4?
      codeOBX-3
      value[x]OBX.2, OBX.5, OBX.6
      dataAbsentReasonN/A
      interpretationOBX-8
      referenceRangeOBX.7

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

ImmunizationObservation
ObservationEntity. Role, or Act, Observation[classCode=OBS, moodCode=EVN]
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifierid
   basedOn.inboundRelationship[typeCode=COMP].source[moodCode=EVN]
   partOf.outboundRelationship[typeCode=FLFS].target
   statusstatus Amended & Final are differentiated by whether it is the subject of a ControlAct event with a type of "revise"
   category.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
   codecode
   subjectparticipation[typeCode=RTGT]
   focusparticipation[typeCode=SBJ]
   encounterinboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
   effective[x]effectiveTime
   issuedparticipation[typeCode=AUT].time
   performerparticipation[typeCode=PRF]
   value[x]value
   value[x] (valueCodeableConcept)value
      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
   dataAbsentReasonvalue.nullFlavor
   interpretationinterpretationCode
   notesubjectOf.observationEvent[code="annotation"].value
   bodySitetargetSiteCode
   methodmethodCode
   specimenparticipation[typeCode=SPC].specimen
   deviceparticipation[typeCode=DEV]
   referenceRangeoutboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]
      idn/a
      extensionn/a
      modifierExtensionN/A
      lowvalue:IVL_PQ.low
      highvalue:IVL_PQ.high
      typeinterpretationCode
      appliesTointerpretationCode
      ageoutboundRelationship[typeCode=PRCN].targetObservationCriterion[code="age"].value
      textvalue:ST
   hasMemberoutBoundRelationship
   derivedFrom.targetObservation
   componentoutBoundRelationship[typeCode=COMP]
      idn/a
      extensionn/a
      modifierExtensionN/A
      codecode
      value[x]value
      dataAbsentReasonvalue.nullFlavor
      interpretationinterpretationCode
      referenceRangeoutboundRelationship[typeCode=REFV]/target[classCode=OBS, moodCode=EVN]

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

ImmunizationObservation
Observation
   identifierFiveWs.identifier
   statusFiveWs.status
   categoryFiveWs.class
   codeFiveWs.what[x]
   subjectFiveWs.subject[x], FiveWs.subject
   focusFiveWs.subject[x], FiveWs.subject
   encounterFiveWs.context
   effective[x]FiveWs.done[x]
   issuedFiveWs.recorded
   performerFiveWs.actor
   component
      codeFiveWs.what[x]

Mappings for SNOMED CT Attribute Binding (http://snomed.org/attributebinding)

ImmunizationObservation
Observation
   code116680003 |Is a|
   value[x]363714003 |Interprets|
   value[x] (valueCodeableConcept)363714003 |Interprets|
   interpretation363713009 |Has interpretation|
   bodySite718497002 |Inherent location|
   specimen704319004 |Inherent in|
   device424226004 |Using device|
   component
      value[x]363714003 |Interprets|
      interpretation363713009 |Has interpretation|