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

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.1.2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: BeVaccination - Mappings

Active as of 2025-11-27 Maturity Level: 1

Mappings for the be-vaccination resource profile.

Mappings to Structures in this Implementation Guide

NameBeModelVaccinationToBVaccinationdoco
.. Immunization
    ... id
      ... meta
        ... implicitRules
          ... language
            ... text
              ... contained
                ... Slices for extension
                  .... extension:vaccination-originalorder
                    .... extension:administeredProduct
                      .... extension:vaccination-confirmationStatus
                        .... extension:recorder
                          .... extension:note
                            .... extension:vaccination-stock-location
                              .... extension:vaccination-stock-funding-organization
                                ... modifierExtension
                                  ... identifier
                                    .... id
                                      .... extension
                                        .... use
                                          .... type
                                            .... system
                                              .... value
                                                .... period
                                                  .... assigner
                                                    ... status
                                                      ... statusReason
                                                        ... vaccineCode
                                                          ... patient
                                                            ... encounter
                                                              ... Slices for occurrence[x]
                                                                .... occurrence[x]:occurrenceDateTime
                                                                  .... occurrence[x]:occurrenceString
                                                                    ... recorded
                                                                      ... primarySource
                                                                        ... reportOrigin
                                                                          ... location
                                                                            ... manufacturer
                                                                              ... lotNumber
                                                                                ... expirationDate
                                                                                  ... site
                                                                                    .... id
                                                                                      .... Slices for extension
                                                                                        ..... extension:bodyLaterality
                                                                                          .... coding
                                                                                            .... text
                                                                                              ... route
                                                                                                ... doseQuantity
                                                                                                  ... performer
                                                                                                    .... id
                                                                                                      .... extension
                                                                                                        .... modifierExtension
                                                                                                          .... function
                                                                                                            .... actor
                                                                                                              ... note
                                                                                                                ... reasonCode
                                                                                                                  ... reasonReference
                                                                                                                    ... isSubpotent
                                                                                                                      ... subpotentReason
                                                                                                                        ... education
                                                                                                                          .... id
                                                                                                                            .... extension
                                                                                                                              .... modifierExtension
                                                                                                                                .... documentType
                                                                                                                                  .... reference
                                                                                                                                    .... publicationDate
                                                                                                                                      .... presentationDate
                                                                                                                                        ... programEligibility
                                                                                                                                          ... fundingSource
                                                                                                                                            ... reaction
                                                                                                                                              .... id
                                                                                                                                                .... extension
                                                                                                                                                  .... modifierExtension
                                                                                                                                                    .... date
                                                                                                                                                      .... detail
                                                                                                                                                        .... reported
                                                                                                                                                          ... protocolApplied

                                                                                                                                                            doco Documentation for this format

                                                                                                                                                            Mappings to other Structures

                                                                                                                                                            No Mappings Found

                                                                                                                                                            Other Mappings

                                                                                                                                                            NameWorkflow PatternHL7 v2 MappingRIM MappingFiveWs Pattern MappingCDA (R2)doco
                                                                                                                                                            .. Immunization
                                                                                                                                                            Event
                                                                                                                                                            VXU_V04
                                                                                                                                                            SubstanceAdministration
                                                                                                                                                            ... id
                                                                                                                                                            ... meta
                                                                                                                                                            ... implicitRules
                                                                                                                                                            ... language
                                                                                                                                                            ... text
                                                                                                                                                            Act.text?
                                                                                                                                                            ... contained
                                                                                                                                                            N/A
                                                                                                                                                            ... Slices for extension
                                                                                                                                                            .... extension:vaccination-originalorder
                                                                                                                                                            .... extension:administeredProduct
                                                                                                                                                            .... extension:vaccination-confirmationStatus
                                                                                                                                                            .... extension:recorder
                                                                                                                                                            .... extension:note
                                                                                                                                                            .... extension:vaccination-stock-location
                                                                                                                                                            .... extension:vaccination-stock-funding-organization
                                                                                                                                                            ... modifierExtension
                                                                                                                                                            N/A
                                                                                                                                                            ... identifier
                                                                                                                                                            Event.identifier
                                                                                                                                                            .id
                                                                                                                                                            FiveWs.identifier
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
                                                                                                                                                            .... id
                                                                                                                                                            n/a
                                                                                                                                                            .... extension
                                                                                                                                                            n/a
                                                                                                                                                            .... use
                                                                                                                                                            N/A
                                                                                                                                                            Role.code or implied by context
                                                                                                                                                            .... type
                                                                                                                                                            CX.5
                                                                                                                                                            Role.code or implied by context
                                                                                                                                                            .... system
                                                                                                                                                            CX.4 / EI-2-4
                                                                                                                                                            II.root or Role.id.root
                                                                                                                                                            .... value
                                                                                                                                                            CX.1 / EI.1
                                                                                                                                                            II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
                                                                                                                                                            .... period
                                                                                                                                                            CX.7 + CX.8
                                                                                                                                                            Role.effectiveTime or implied by context
                                                                                                                                                            .... assigner
                                                                                                                                                            • CX.4 / (CX.4
                                                                                                                                                            • CX.9
                                                                                                                                                            • CX.10)
                                                                                                                                                            II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
                                                                                                                                                            ... status
                                                                                                                                                            Event.status
                                                                                                                                                            statusCode
                                                                                                                                                            FiveWs.status
                                                                                                                                                            ... statusReason
                                                                                                                                                            Event.statusReason
                                                                                                                                                            • .inboundRelationship[typeCode=SUBJ].source[classCode=CACT
                                                                                                                                                            • moodCode=EVN].reasonCOde
                                                                                                                                                            ... vaccineCode
                                                                                                                                                            Event.code
                                                                                                                                                            RXA-5
                                                                                                                                                            .code
                                                                                                                                                            FiveWs.what[x]
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
                                                                                                                                                            ... patient
                                                                                                                                                            Event.subject
                                                                                                                                                            PID-3
                                                                                                                                                            .partipication[ttypeCode=].role
                                                                                                                                                            FiveWs.subject
                                                                                                                                                            ... encounter
                                                                                                                                                            Event.context
                                                                                                                                                            PV1-19
                                                                                                                                                            component->EncounterEvent
                                                                                                                                                            FiveWs.context
                                                                                                                                                            ... Slices for occurrence[x]
                                                                                                                                                            Event.occurrence[x]
                                                                                                                                                            RXA-3
                                                                                                                                                            .effectiveTime
                                                                                                                                                            FiveWs.done[x]
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
                                                                                                                                                            .... occurrence[x]:occurrenceDateTime
                                                                                                                                                            Event.occurrence[x]
                                                                                                                                                            RXA-3
                                                                                                                                                            .effectiveTime
                                                                                                                                                            FiveWs.done[x]
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
                                                                                                                                                            .... occurrence[x]:occurrenceString
                                                                                                                                                            Event.occurrence[x]
                                                                                                                                                            RXA-3
                                                                                                                                                            .effectiveTime
                                                                                                                                                            FiveWs.done[x]
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
                                                                                                                                                            ... recorded
                                                                                                                                                            .participation[typeCode=AUT].time
                                                                                                                                                            FiveWs.recorded
                                                                                                                                                            ... primarySource
                                                                                                                                                            RXA-9
                                                                                                                                                            • immunization.uncertaintycode (if primary source=false
                                                                                                                                                            • uncertainty=U)
                                                                                                                                                            FiveWs.source
                                                                                                                                                            ... reportOrigin
                                                                                                                                                            RXA-9
                                                                                                                                                            .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)
                                                                                                                                                            FiveWs.source
                                                                                                                                                            ... location
                                                                                                                                                            Event.location
                                                                                                                                                            • RXA-27 (or RXA-11
                                                                                                                                                            • deprecated as of v2.7)
                                                                                                                                                            .participation[typeCode=LOC].COCT_MT240000UV
                                                                                                                                                            FiveWs.where[x]
                                                                                                                                                            ... manufacturer
                                                                                                                                                            RXA-17
                                                                                                                                                            .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
                                                                                                                                                            ... lotNumber
                                                                                                                                                            RXA-15
                                                                                                                                                            .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
                                                                                                                                                            ... expirationDate
                                                                                                                                                            RXA-16
                                                                                                                                                            .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
                                                                                                                                                            ... site
                                                                                                                                                            RXR-2
                                                                                                                                                            observation.targetSiteCode
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code
                                                                                                                                                            .... id
                                                                                                                                                            n/a
                                                                                                                                                            .... Slices for extension
                                                                                                                                                            n/a
                                                                                                                                                            ..... extension:bodyLaterality
                                                                                                                                                            .... coding
                                                                                                                                                            • C*E.1-8
                                                                                                                                                            • C*E.10-22
                                                                                                                                                            • union(.
                                                                                                                                                            • ./translation)
                                                                                                                                                            .... text
                                                                                                                                                            C*E.9. But note many systems use C*E.2 for this
                                                                                                                                                            ./originalText[mediaType/code="text/plain"]/data
                                                                                                                                                            ... route
                                                                                                                                                            RXR-1
                                                                                                                                                            .routeCode
                                                                                                                                                            ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code
                                                                                                                                                            ... doseQuantity
                                                                                                                                                            RXA-6 / RXA-7
                                                                                                                                                            .doseQuantity
                                                                                                                                                            ... performer
                                                                                                                                                            Event.performer
                                                                                                                                                            ORC-12 / RXA-10
                                                                                                                                                            .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
                                                                                                                                                            .... id
                                                                                                                                                            n/a
                                                                                                                                                            .... extension
                                                                                                                                                            n/a
                                                                                                                                                            .... modifierExtension
                                                                                                                                                            N/A
                                                                                                                                                            .... function
                                                                                                                                                            Event.performer.function
                                                                                                                                                            .participation.functionCode
                                                                                                                                                            .... actor
                                                                                                                                                            Event.performer.actor
                                                                                                                                                            .player
                                                                                                                                                            FiveWs.actor
                                                                                                                                                            ... note
                                                                                                                                                            Event.note
                                                                                                                                                            OBX-3 = 48767-8
                                                                                                                                                            note
                                                                                                                                                            ... reasonCode
                                                                                                                                                            Event.reasonCode
                                                                                                                                                            [actionNegationInd=false].reasonCode
                                                                                                                                                            ... reasonReference
                                                                                                                                                            Event.reasonReference
                                                                                                                                                            N/A
                                                                                                                                                            ... isSubpotent
                                                                                                                                                            RXA-20 = PA (partial administration)
                                                                                                                                                            N/A
                                                                                                                                                            ... subpotentReason
                                                                                                                                                            N/A
                                                                                                                                                            ... education
                                                                                                                                                            N/A
                                                                                                                                                            .... id
                                                                                                                                                            n/a
                                                                                                                                                            .... extension
                                                                                                                                                            n/a
                                                                                                                                                            .... modifierExtension
                                                                                                                                                            N/A
                                                                                                                                                            .... documentType
                                                                                                                                                            OBX-3 = 69764-9
                                                                                                                                                            N/A
                                                                                                                                                            .... reference
                                                                                                                                                            N/A
                                                                                                                                                            .... publicationDate
                                                                                                                                                            OBX-3 = 29768-9
                                                                                                                                                            N/A
                                                                                                                                                            .... presentationDate
                                                                                                                                                            OBX-3 = 29769-7
                                                                                                                                                            N/A
                                                                                                                                                            ... programEligibility
                                                                                                                                                            OBX-3 = 64994-7
                                                                                                                                                            N/A
                                                                                                                                                            ... fundingSource
                                                                                                                                                            N/A
                                                                                                                                                            ... reaction
                                                                                                                                                            OBX-3
                                                                                                                                                            Observation[classCode=obs].code
                                                                                                                                                            .... id
                                                                                                                                                            n/a
                                                                                                                                                            .... extension
                                                                                                                                                            n/a
                                                                                                                                                            .... modifierExtension
                                                                                                                                                            N/A
                                                                                                                                                            .... date
                                                                                                                                                            • OBX-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)
                                                                                                                                                            .effectiveTime
                                                                                                                                                            .... detail
                                                                                                                                                            OBX-5
                                                                                                                                                            .value
                                                                                                                                                            .... reported
                                                                                                                                                            (HL7 v2 doesn't seem to provide for this)
                                                                                                                                                            .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
                                                                                                                                                            ... protocolApplied
                                                                                                                                                            N/A

                                                                                                                                                            doco Documentation for this format