RIVO-Noord Zorgviewer Implementation Guide
1.9.0 - CI build Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.9.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Vaccination - Mappings

Active as of 2024-12-10

Mappings for the Immunization resource profile.

Mappings for HCIM Vaccination-v3.1(2017EN) (https://zibs.nl/wiki/Vaccination-v3.1(2017EN))

Vaccination
ImmunizationNL-CM:11.1.1

Vaccination
   vaccineCodeNL-CM:11.1.2

ProductCode
   dateNL-CM:11.1.3

VaccinationDate
   doseQuantityNL-CM:11.1.4

Dose
   practitioner
      actorNL-CM:11.1.6

Administrator
   note
      textNL-CM:11.1.7

Comment

Mappings for HCIM HealthProfessional-v3.2(2017EN) (https://zibs.nl/wiki/HealthProfessional-v3.2(2017EN))

Vaccination
Immunization
   practitioner
      role
         coding (healthProfessionalRole)NL-CM:17.1.5

HealthProfessionalRole

Mappings for HCIM BasicElements-v1.0(2017EN) (https://zibs.nl/wiki/BasicElements-v1.0(2017EN))

Vaccination
Immunization
   identifierNL-CM:0.0.6

IdentificationNumber
   patientNL-CM:0.0.11

Subject
   dateNL-CM:0.0.14

DateTime
   reportOriginNL-CM:0.0.2

InformationSource
   practitionerNL-CM:0.0.7

Author

Mappings for HCIM Vaccination-v3.0(2016EN) (https://zibs.nl/wiki/Vaccination-v3.0(2016EN))

Vaccination
ImmunizationNL-CM:11.1.1

Vaccination
   vaccineCodeNL-CM:11.1.2

ProductCode
   dateNL-CM:11.1.3

VaccinationDate
   doseQuantityNL-CM:11.1.4

Dose
   practitioner
      actorNL-CM:11.1.6

Administrator
   note
      textNL-CM:11.1.7

Explanation

Mappings for HCIM HealthProfessional-v3.0(2016EN) (https://zibs.nl/wiki/HealthProfessional-v3.0(2016EN))

Vaccination
Immunization
   practitioner
      role
         coding (healthProfessionalRole)NL-CM:17.1.5

HealthcareProviderRole

Mappings for HCIM Vaccination-v1.2(2015EN) (https://zibs.nl/wiki/Vaccination-v1.2(2015EN))

Vaccination
ImmunizationNL-CM:11.1.1

Vaccination
   vaccineCodeNL-CM:11.1.2

ProductCode
   dateNL-CM:11.1.3

VaccinationDate
   doseQuantityNL-CM:11.1.4

Dose
   practitioner
      actorNL-CM:11.1.6

Administrator
   note
      textNL-CM:11.1.7

Explanation

Mappings for HCIM HealthProfessional-v1.2.1(2015EN) (https://zibs.nl/wiki/HealthProfessional-v1.2.1(2015EN))

Vaccination
Immunization
   practitioner
      role
         coding (healthProfessionalRole)NL-CM:17.1.5

HealthcareProviderRole

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

Vaccination
ImmunizationVXU_V04
   vaccineCodeRXA-5
      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
      coding (productCodeGPKCodelijst)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 (productCodeHPKCodelijst)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 (productCodeZICodelijst)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 (productCodeATCCodelijst)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 (productCodePRKCodelijst)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 (productCodeGTINCodelijst)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
   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
      role
         codingC*E.1-8, C*E.10-22
         coding (healthProfessionalRole)C*E.1-8, C*E.10-22
         textC*E.9. But note many systems use C*E.2 for this
   note
      author[x]N/A
      timeN/A
      textN/A
   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)

Vaccination
ImmunizationEntity. Role, or Act, SubstanceAdministration
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   statusstatusCode
   notGiven[actionNegationInd=true].reasonCode
   vaccineCode.code
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (productCodeGPKCodelijst)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (productCodeHPKCodelijst)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (productCodeZICodelijst)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (productCodeATCCodelijst)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (productCodePRKCodelijst)union(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      coding (productCodeGTINCodelijst)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
   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
         idn/a
         extensionn/a
         codingunion(., ./translation)
         coding (healthProfessionalRole)union(., ./translation)
         text./originalText[mediaType/code="text/plain"]/data
      actor.player
         idn/a
         extension (practitionerRole)n/a, N/A
         referenceN/A
         identifier.identifier
         displayN/A
   notenote
      idn/a
      extensionn/a
      author[x]Act.participant[typeCode=AUT].role
      timeAct.effectiveTime
      textAct.text
   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)

Vaccination
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)

Vaccination
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)

Vaccination
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