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

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.1.1: 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

Official URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination Version: 1.1.1
Active as of 2025-03-24 Maturity Level: 1 Computable Name: BeVaccination

Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:vaccination-originalorder 0..1 Reference(ImmunizationRecommendation | MedicationRequest | CarePlan) BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:administeredProduct 0..1 (Complex) BeAdministeredProduct
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:vaccination-confirmationStatus 0..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... system SΣ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code The status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


ele-1: All FHIR elements must have a @value or children
... statusReason S 0..1 CodeableConcept Reason not done
Binding: BeVSVaccinationStatusReason (required)
ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣ 1..1 CodeableConcept The vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
ele-1: All FHIR elements must have a @value or children
... patient SΣ 1..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
ele-1: All FHIR elements must have a @value or children
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
ele-1: All FHIR elements must have a @value or children
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
ele-1: All FHIR elements must have a @value or children
.... occurrence[x]:occurrenceString SΣ 0..1 string Vaccine administration date
ele-1: All FHIR elements must have a @value or children
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
ele-1: All FHIR elements must have a @value or children
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
ele-1: All FHIR elements must have a @value or children
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
ele-1: All FHIR elements must have a @value or children
... performer SΣ 0..1 BackboneElement Who performed event
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... actor Σ 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
ele-1: All FHIR elements must have a @value or children
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
ele-1: All FHIR elements must have a @value or children
... isSubpotent ?!Σ 0..1 boolean Dose potency
ele-1: All FHIR elements must have a @value or children
... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... date 1..1 dateTime When reaction started
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf vaccineCode.code is other, then vaccinecode text must exist
: (vaccineCode.coding.where(code = 'other').exists() or vaccineCode.coding.where(code = '787859002' and system = 'http://snomed.info/sct').exists() ) implies vaccineCode.text.exists()
be-rule-vaccination-2errorImmunizationThe product code SHALL be cnk, cti extended or atc
: (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).exists().not() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).coding.where(system = 'https://www.ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-cnk-codes').exists() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).coding.where(system = 'https://www.ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-cti-extended-code').exists() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).coding.where(system = 'http://whocc.no/atc').exists()
be-rule-vaccination-3errorImmunizationThe reaction detail code SHALL come from be-vs-reaction-manifestation
: reaction.detail.empty() or reaction.detail.resolve().code.memberOf('https://www.ehealth.fgov.be/standards/fhir/core-clinical/ValueSet/be-vs-reaction-manifestation-code').anyTrue()
be-rule-vaccination-4errorImmunizationIf the encounter has a location, and it has a type, its type should be from be-vs-care-location
: encounter.empty() or encounter.resolve().location.empty() or encounter.resolve().location.location.resolve().type.empty() or encounter.resolve().location.location.resolve().type.coding.memberOf('https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-care-location').anyTrue()

 

Other representations of profile: CSV, Excel, Schematron