HL7 Belgium Vaccination (Patient Dossier)
1.0.3 - STU Belgium flag

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.3: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BeVaccination - Mappings

Active as of 2023-06-26 Maturity Level: 1

Mappings for the be-vaccination resource profile.

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

BeVaccination
ImmunizationEvent
   identifierEvent.identifier
   statusEvent.status
   statusReasonEvent.statusReason
   vaccineCodeEvent.code
   patientEvent.subject
   encounterEvent.context
   occurrence[x]Event.occurrence[x]
   occurrence[x] (occurrenceDateTime)Event.occurrence[x]
   occurrence[x] (occurrenceString)Event.occurrence[x]
   performerEvent.performer
      functionEvent.performer.function
      actorEvent.performer.actor
   noteEvent.note
   reasonCodeEvent.reasonCode
   reasonReferenceEvent.reasonReference

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

BeVaccination
ImmunizationVXU_V04
   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)
   vaccineCodeRXA-5
   patientPID-3
   encounterPV1-19
   occurrence[x]RXA-3
   occurrence[x] (occurrenceDateTime)RXA-3
   occurrence[x] (occurrenceString)RXA-3
   primarySourceRXA-9
   reportOriginRXA-9
   manufacturerRXA-17
   siteRXR-2
      codingC*E.1-8, C*E.10-22
      textC*E.9. But note many systems use C*E.2 for this
   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)

BeVaccination
ImmunizationEntity. Role, or Act, SubstanceAdministration
   textAct.text?
   containedN/A
   modifierExtensionN/A
   identifier.id
      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
   statusstatusCode
   statusReason.inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
   vaccineCode.code
   patient.partipication[ttypeCode=].role
   encountercomponent->EncounterEvent
   occurrence[x].effectiveTime
   occurrence[x] (occurrenceDateTime).effectiveTime
   occurrence[x] (occurrenceString).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)
   manufacturer.participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
   siteobservation.targetSiteCode
      idn/a
      extensionn/a
      codingunion(., ./translation)
      text./originalText[mediaType/code="text/plain"]/data
   route.routeCode
   doseQuantity.doseQuantity
   performer.participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
      idn/a
      extensionn/a
      modifierExtensionN/A
      function.participation.functionCode
      actor.player
   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)

BeVaccination
Immunization
   identifierFiveWs.identifier
   statusFiveWs.status
   vaccineCodeFiveWs.what[x]
   patientFiveWs.subject[x], FiveWs.subject
   encounterFiveWs.context
   occurrence[x]FiveWs.done[x]
   occurrence[x] (occurrenceDateTime)FiveWs.done[x]
   occurrence[x] (occurrenceString)FiveWs.done[x]
   recordedFiveWs.recorded
   primarySourceFiveWs.source
   reportOriginFiveWs.source
   performer
      actorFiveWs.actor

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

BeVaccination
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
   occurrence[x] (occurrenceDateTime)ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
   occurrence[x] (occurrenceString)ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
   manufacturerClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
   siteClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
   routeClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code