SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU1 Release International flag

SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-shc-vaccination-ig/ and changes regularly. See the Directory of published versions

Resource Profile: SHCVaccinationAD - Mappings

Draft as of 2024-12-04

Mappings for the shc-vaccination-ad resource profile.

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

SHCVaccinationAD
ImmunizationEvent
   identifierEvent.identifier
   statusEvent.status
   vaccineCodeEvent.code
   patientEvent.subject
   encounterEvent.context
   occurrence[x]Event.occurrence[x]
   locationEvent.location
   performerEvent.performer
      functionEvent.performer.function
      actorEvent.performer.actor
   noteEvent.note
   reasonCodeEvent.reasonCode
   reasonReferenceEvent.reasonReference

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

SHCVaccinationAD
ImmunizationVXU_V04
   vaccineCodeRXA-5
      codingC*E.1-8, C*E.10-22
      coding (cvx)C*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
      coding (snomed)C*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
      coding (icd11)C*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
   patientPID-3
   encounterPV1-19
   occurrence[x]RXA-3
   primarySourceRXA-9
   reportOriginRXA-9
   locationRXA-27 (or RXA-11, deprecated as of v2.7)
   manufacturerRXA-17
      identifier
         useN/A
         typeCX.5
         systemCX.4 / EI-2-4
         valueCX.1 / EI.1
         periodCX.7 + CX.8
         assignerCX.4 / (CX.4,CX.9,CX.10)
   lotNumberRXA-15
   expirationDateRXA-16
   siteRXR-2
   routeRXR-1
   doseQuantityRXA-6 / RXA-7
   performerORC-12 / RXA-10
   noteOBX-5 : OBX-3 = 48767-8
   isSubpotentRXA-20 = PA (partial administration)
   education
      documentTypeOBX-5 : OBX-3 = 69764-9
      publicationDateOBX-5 : OBX-3 = 29768-9
      presentationDateOBX-5 : OBX-3 = 29769-7
   programEligibilityOBX-5 : OBX-3 = 64994-7
   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(HL7 v2 doesn't seem to provide for this)

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

SHCVaccinationAD
ImmunizationEntity. Role, or Act, SubstanceAdministration
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   vaccineCode.code
      idn/a
      extensionn/a
      codingunion(., ./translation)
      coding (cvx)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (snomed)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (icd11)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   patient.partipication[ttypeCode=].role
      idn/a
      extensionn/a
      referenceN/A
   encountercomponent->EncounterEvent
   occurrence[x].effectiveTime
   recorded.participation[typeCode=AUT].time
   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]
      idn/a
      extensionn/a
      referenceN/A
      typeN/A
      identifier.identifier
         idn/a
         extensionn/a
         useRole.code or implied by context
         typeRole.code or implied by context
         systemII.root or Role.id.root
         valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
         periodRole.effectiveTime or implied by context
         assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
      displayN/A
   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
   performer.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      function.participation.functionCode
      actor.player
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
   notenote
   reasonCode[actionNegationInd=false].reasonCode
   reasonReferenceN/A
   isSubpotentN/A
   subpotentReasonN/A
   educationN/A
      idn/a
      extensionn/a
      modifierExtensionN/A
      documentTypeN/A
      referenceN/A
      publicationDateN/A
      presentationDateN/A
   programEligibilityN/A
   fundingSourceN/A
   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)

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

SHCVaccinationAD
Immunization
   identifierFiveWs.identifier
   statusFiveWs.status
   vaccineCodeFiveWs.what[x]
   patientFiveWs.subject[x], FiveWs.subject
   encounterFiveWs.context
   occurrence[x]FiveWs.done[x]
   recordedFiveWs.recorded
   primarySourceFiveWs.source
   reportOriginFiveWs.source
   locationFiveWs.where[x]
   performer
      actorFiveWs.actor

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

SHCVaccinationAD
Immunization
   identifierClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
   vaccineCodeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
   occurrence[x]ClinicalDocument/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