US Core Implementation Guide (Release 1.1.0 Ballot )

This page is part of the US Core (v1.1.0: STU2 Ballot) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 8.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R8 R7 R6 R5 R4 R3

D.4.1.4 StructureDefinition: US Core Immunization Profile - Mappings

Mappings for the StructureDefinition-us-core-immunization Profile.

Mappings for QUICK (http://unknown.org/QUICK)

US Core Immunization Profile
ImmunizationImmunizationPerformanceOccurrence
   vaccineCodevaccine
   patientsubject
   dateperformanceTime
   primarySourcereported

Mappings for Argonaut-DQ-DSTU2 (http://unknown.org/Argonaut-DQ-DSTU2)

US Core Immunization Profile
ImmunizationImmunization
   statusImmunization.status
   notGivenImmunization.wasNotGiven
   vaccineCodeImmunization.vaccineCode
   patientImmunization.patient
   dateImmunization.date
   primarySourceImmunization.reported

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

US Core Immunization Profile
ImmunizationVXU_V04
   vaccineCodeRXA-5
   patientPID-3
   encounterPV1-19
   dateRXA-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.1
   practitionerORC-12 / RXA-10
   explanation
      reasonNotGivenRXA-18
   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(no such concept seems to exist for allergy/adverse reaction in HL7 v2)
   vaccinationProtocol(HL7 v2 doesn't seem to provide for this)

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

US Core Immunization Profile
ImmunizationEntity. Role, or Act
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   notGiven[actionNegationInd=true].reasonCode
   vaccineCode.code
   patient.partipication[ttypeCode=].role
   encountercomponent->EncounterEvent
   date.effectiveTime
   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]
   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
   practitioner.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      role.participation.functionCode
      actor.player
   notenote
   explanationn/a
      idn/a
      extensionn/a
      modifierExtensionN/A
      reason[actionNegationInd=false].reasonCode
      reasonNotGiven[actionNegationInd=true].reasonCode
   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)
   vaccinationProtocoloutboundRelationship[typeCode=INST].target[classCode=SBADM]
      idn/a
      extensionn/a
      modifierExtensionN/A
      doseSequenceoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber
      descriptionoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
      authorityoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV
      seriesoutboundRelationship[typeCode=INST].target[classCode=SBADM]
      seriesDosesoutboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text
      targetDiseaseoutboundRelationship.target[classCode=OBS].code
      doseStatus.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value
      doseStatusReason.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode

Mappings for W5 Mapping (http://hl7.org/fhir/w5)

US Core Immunization Profile
Immunizationclinical.medication
   identifierid
   statusstatus
   notGivenstatus
   vaccineCodewhat
   patientwho.focus
   encountercontext
   datewhen.init
   primarySourcewho.source
   reportOriginwho.source
   locationwhere
   practitioner
      actorwho.actor

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

US Core Immunization Profile
Immunization
   identifierEvent.identifier
   statusEvent.status
   notGivenEvent.notDone
   vaccineCodeEvent.code
   patientEvent.subject
   encounterEvent.context
   dateEvent.occurrence.occurrenceDateTime
   practitionerEvent.performer
      roleEvent.performer.role
      actorEvent.performer.actor
   noteEvent.note
   explanation
      reasonEvent.reasonCodeableConcept
      reasonNotGivenEvent.notDoneReason

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

US Core Immunization Profile
Immunization
   identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
   vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
   dateClinicalDocument/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