US-Core CI Build

This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: US Core Immunization Profile - Mappings

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

Mappings for Quality Improvement and Clinical Knowledge (QUICK) (http://wiki.siframework.org/CQF)

US Core Immunization Profile
ImmunizationUSCoreImmunizationImmunizationPerformanceOccurrence
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   identifier
   status
   dateperformanceTime
   vaccineCodevaccine
      id
      extension
      coding
      codingUSCoreVaccineCodesvaccine
      codingvaccine
      text
   patientsubject
   wasNotGiven
   primarySourcereported
   reportOrigin
   performer
   requester
   encounter
   manufacturer
   location
   lotNumber
   expirationDate
   site
   route
   doseQuantity
   note
   explanation
      id
      extension
      modifierExtension
      reason
      reasonNotGiven
   reaction
      id
      extension
      modifierExtension
      date
      detail
      reported
   vaccinationProtocol
      id
      extension
      modifierExtension
      doseSequence
      description
      authority
      series
      seriesDoses
      targetDisease
      doseStatus
      doseStatusReason

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

US Core Immunization Profile
ImmunizationUSCoreImmunizationVXU_V04
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   identifier
   status
   dateRXA-3
   vaccineCodeRXA-5
      id
      extension
      codingC*E.1-8, C*E.10-22
      codingUSCoreVaccineCodesC*E.1-8, C*E.10-22
      codingC*E.1-8, C*E.10-22
      textC*E.9. But note many systems use C*E.2 for this
   patientPID-3
   wasNotGiven
   primarySourceRXA-9
   reportOriginRXA-9
   performerRXA-10
   requesterORC-12
   encounterPV1-19
   manufacturerRXA-17
   locationRXA-27 (or RXA-11, deprecated as of v2.7)
   lotNumberRXA-15
   expirationDateRXA-16
   siteRXR-2
   routeRXR-1
   doseQuantityRXA-6 / RXA-7.1
   note
   explanation
      id
      extension
      modifierExtension
      reason
      reasonNotGivenRXA-18
   reactionOBX-3
      id
      extension
      modifierExtension
      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)
      id
      extension
      modifierExtension
      doseSequence
      description
      authority
      series
      seriesDoses
      targetDisease
      doseStatus
      doseStatusReason

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

US Core Immunization Profile
ImmunizationUSCoreImmunizationEntity. Role, or Act
   id
   meta
   implicitRules
   language
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   date.effectiveTime
   vaccineCode.code
      idn/a
      extensionn/a
      codingunion(., ./translation)
      codingUSCoreVaccineCodesunion(., ./translation)
      codingunion(., ./translation)
      text./originalText[mediaType/code="text/plain"]/data
   patient.partipication[ttypeCode=].role
   wasNotGiven[actionNegationInd=true].reasonCode
   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)
   performer.participation[typeCode=PRF].COCT_MT090102UV
   requesteroutboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV
   encountercomponent->EncounterEvent
   manufacturer.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
   location.participation[typeCode=LOC].COCT_MT240000UV
   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
   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
ImmunizationUSCoreImmunizationclinical.medication
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   identifierid
   statusstatus
   datewhen.init
   vaccineCodewhat
      id
      extension
      coding
      codingUSCoreVaccineCodes
      coding
      text
   patientwho.focus
   wasNotGivenstatus
   primarySourcewho.source
   reportOriginwho.source
   performerwho.actor
   requesterwho.cause
   encountercontext
   manufacturer
   locationwhere
   lotNumber
   expirationDate
   site
   route
   doseQuantity
   note
   explanation
      id
      extension
      modifierExtension
      reason
      reasonNotGiven
   reaction
      id
      extension
      modifierExtension
      date
      detail
      reported
   vaccinationProtocol
      id
      extension
      modifierExtension
      doseSequence
      description
      authority
      series
      seriesDoses
      targetDisease
      doseStatus
      doseStatusReason

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

US Core Immunization Profile
ImmunizationUSCoreImmunization
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
   status
   dateClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
   vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
      id
      extension
      coding
      codingUSCoreVaccineCodes
      coding
      text
   patient
   wasNotGiven
   primarySource
   reportOrigin
   performerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name
   requester
   encounter
   manufacturerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
   location
   lotNumberClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
   expirationDate
   siteClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
   routeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
   doseQuantity
   note
   explanation
      id
      extension
      modifierExtension
      reason
      reasonNotGiven
   reaction
      id
      extension
      modifierExtension
      date
      detail
      reported
   vaccinationProtocol
      id
      extension
      modifierExtension
      doseSequence
      description
      authority
      series
      seriesDoses
      targetDisease
      doseStatus
      doseStatusReason