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

HL7 Belgium Vaccination (Patient Dossier), published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/vaccination/ and changes regularly. See the Directory of published versions

Logical Model: BeModelVaccination

Official URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination Version: 1.1.0
Draft as of 2024-09-09 Computable Name: BeModelVaccination

Logical Model for vaccination

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-vaccination 0..* Element
Elements defined in Ancestors:@id, extension
BeModelVaccination
Instances of this logical model are not marked to be the target of a Reference
... recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded
... patient 1..1 Reference(Patient) The patient that received vaccination.
... vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination
... performer 0..1 Reference(Practitioner) The professional that administered the medication
... vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... vaccinationDate[x] 0..1 The date and time when the vaccination has been administered
.... vaccinationDateDateTime dateTime
.... vaccinationDateString string
... administeredProduct 0..1 BackboneElement The details of the product that was administered.
.... product[x] 0..1 The actual product that was administered. This should be a product code or a reference to an actual Medication resource
..... productReference Reference(Any)
..... productCodeableConcept CodeableConcept
.... lotNumber 0..1 string The lot number
.... expirationDate 0..1 date The expiration date of the product.
... route 0..1 CodeableConcept The route of administration.
... status 1..1 code The status of this vaccination record entry
... statusReason 0..1 CodeableConcept The reason for the status e.g. 'not completed because...'
Binding: BeVSVaccinationStatusReason (required): Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

... reaction 0..1 BackboneElement Reaction to the immunization - cfr. AllergyIntolerance
.... reactionDate 1..1 dateTime date of the reaction
.... manifestation 0..1 Reference() reference to the observation of the reaction
... doseQuantity 0..1 BackboneElement The number or quantity of product(s) that was administered - e.g. 1/2 dose
... note 0..1 Attachment Additional notes for the vaccination.
... site 1..1 CodeableConcept The body site where the vaccination entered the body
... identifier 0..* Identifier The business identifier(s) for the vaccination entry
... bodyLaterality 0..1 CodeableConcept The side of the body (for sites that occur on both sides of the body)
... location 0..1 Reference() The location where the immunization is performed.
... locationType 0..1 CodeableConcept The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
... cause 0..1 CodeableConcept Is the vaccination due to pre or post exposition prophylaxis?
... stockOrigin 0..1 Reference(Location) The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
... stockFundingEntity 0..1 Reference(Organization) The entity that is funding the provision of the vaccines

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
be-model-vaccination.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-vaccination 0..* Element
Elements defined in Ancestors:@id, extension
BeModelVaccination
Instances of this logical model are not marked to be the target of a Reference
... recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded
... patient 1..1 Reference(Patient) The patient that received vaccination.
... vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination
... performer 0..1 Reference(Practitioner) The professional that administered the medication
... vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... vaccinationDate[x] 0..1 The date and time when the vaccination has been administered
.... vaccinationDateDateTime dateTime
.... vaccinationDateString string
... administeredProduct 0..1 BackboneElement The details of the product that was administered.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product[x] 0..1 The actual product that was administered. This should be a product code or a reference to an actual Medication resource
..... productReference Reference(Any)
..... productCodeableConcept CodeableConcept
.... lotNumber 0..1 string The lot number
.... expirationDate 0..1 date The expiration date of the product.
... route 0..1 CodeableConcept The route of administration.
... status 1..1 code The status of this vaccination record entry
... statusReason 0..1 CodeableConcept The reason for the status e.g. 'not completed because...'
Binding: BeVSVaccinationStatusReason (required): Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

... reaction 0..1 BackboneElement Reaction to the immunization - cfr. AllergyIntolerance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reactionDate 1..1 dateTime date of the reaction
.... manifestation 0..1 Reference() reference to the observation of the reaction
... doseQuantity 0..1 BackboneElement The number or quantity of product(s) that was administered - e.g. 1/2 dose
... note 0..1 Attachment Additional notes for the vaccination.
... site 1..1 CodeableConcept The body site where the vaccination entered the body
... identifier 0..* Identifier The business identifier(s) for the vaccination entry
... bodyLaterality 0..1 CodeableConcept The side of the body (for sites that occur on both sides of the body)
... location 0..1 Reference() The location where the immunization is performed.
... locationType 0..1 CodeableConcept The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
... cause 0..1 CodeableConcept Is the vaccination due to pre or post exposition prophylaxis?
... stockOrigin 0..1 Reference(Location) The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
... stockFundingEntity 0..1 Reference(Organization) The entity that is funding the provision of the vaccines

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-vaccination.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-vaccination 0..* Element
Elements defined in Ancestors:@id, extension
BeModelVaccination
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded
... vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination
... recorder 1..1 Reference(Practitioner) The professional that recorded the administration of the vaccine
... performer 0..1 Reference(Practitioner) The professional that administered the medication
... vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... vaccinationDate[x] 0..1 The date and time when the vaccination has been administered
.... vaccinationDateDateTime dateTime
.... vaccinationDateString string
... administeredProduct 0..1 BackboneElement The details of the product that was administered.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product[x] 0..1 The actual product that was administered. This should be a product code or a reference to an actual Medication resource
..... productReference Reference(Any)
..... productCodeableConcept CodeableConcept
.... lotNumber 0..1 string The lot number
.... expirationDate 0..1 date The expiration date of the product.
... route 0..1 CodeableConcept The route of administration.
... status 1..1 code The status of this vaccination record entry
... statusReason 0..1 CodeableConcept The reason for the status e.g. 'not completed because...'
Binding: BeVSVaccinationStatusReason (required): Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

... reaction 0..1 BackboneElement Reaction to the immunization - cfr. AllergyIntolerance
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reactionDate 1..1 dateTime date of the reaction
.... manifestation 0..1 Reference() reference to the observation of the reaction
... doseQuantity 0..1 BackboneElement The number or quantity of product(s) that was administered - e.g. 1/2 dose
... note 0..1 Attachment Additional notes for the vaccination.
... site 1..1 CodeableConcept The body site where the vaccination entered the body
... identifier 0..* Identifier The business identifier(s) for the vaccination entry
... bodyLaterality 0..1 CodeableConcept The side of the body (for sites that occur on both sides of the body)
... location 0..1 Reference() The location where the immunization is performed.
... locationType 0..1 CodeableConcept The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
... cause 0..1 CodeableConcept Is the vaccination due to pre or post exposition prophylaxis?
... stockOrigin 0..1 Reference(Location) The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
... stockFundingEntity 0..1 Reference(Organization) The entity that is funding the provision of the vaccines

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-vaccination.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG

This structure is derived from Element

Summary

Mandatory: 0 element(7 nested mandatory elements)

Differential View

This structure is derived from Element

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-vaccination 0..* Element
Elements defined in Ancestors:@id, extension
BeModelVaccination
Instances of this logical model are not marked to be the target of a Reference
... recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded
... patient 1..1 Reference(Patient) The patient that received vaccination.
... vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination
... performer 0..1 Reference(Practitioner) The professional that administered the medication
... vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... vaccinationDate[x] 0..1 The date and time when the vaccination has been administered
.... vaccinationDateDateTime dateTime
.... vaccinationDateString string
... administeredProduct 0..1 BackboneElement The details of the product that was administered.
.... product[x] 0..1 The actual product that was administered. This should be a product code or a reference to an actual Medication resource
..... productReference Reference(Any)
..... productCodeableConcept CodeableConcept
.... lotNumber 0..1 string The lot number
.... expirationDate 0..1 date The expiration date of the product.
... route 0..1 CodeableConcept The route of administration.
... status 1..1 code The status of this vaccination record entry
... statusReason 0..1 CodeableConcept The reason for the status e.g. 'not completed because...'
Binding: BeVSVaccinationStatusReason (required): Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

... reaction 0..1 BackboneElement Reaction to the immunization - cfr. AllergyIntolerance
.... reactionDate 1..1 dateTime date of the reaction
.... manifestation 0..1 Reference() reference to the observation of the reaction
... doseQuantity 0..1 BackboneElement The number or quantity of product(s) that was administered - e.g. 1/2 dose
... note 0..1 Attachment Additional notes for the vaccination.
... site 1..1 CodeableConcept The body site where the vaccination entered the body
... identifier 0..* Identifier The business identifier(s) for the vaccination entry
... bodyLaterality 0..1 CodeableConcept The side of the body (for sites that occur on both sides of the body)
... location 0..1 Reference() The location where the immunization is performed.
... locationType 0..1 CodeableConcept The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
... cause 0..1 CodeableConcept Is the vaccination due to pre or post exposition prophylaxis?
... stockOrigin 0..1 Reference(Location) The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
... stockFundingEntity 0..1 Reference(Organization) The entity that is funding the provision of the vaccines

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
be-model-vaccination.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-vaccination 0..* Element
Elements defined in Ancestors:@id, extension
BeModelVaccination
Instances of this logical model are not marked to be the target of a Reference
... recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded
... patient 1..1 Reference(Patient) The patient that received vaccination.
... vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination
... performer 0..1 Reference(Practitioner) The professional that administered the medication
... vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... vaccinationDate[x] 0..1 The date and time when the vaccination has been administered
.... vaccinationDateDateTime dateTime
.... vaccinationDateString string
... administeredProduct 0..1 BackboneElement The details of the product that was administered.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product[x] 0..1 The actual product that was administered. This should be a product code or a reference to an actual Medication resource
..... productReference Reference(Any)
..... productCodeableConcept CodeableConcept
.... lotNumber 0..1 string The lot number
.... expirationDate 0..1 date The expiration date of the product.
... route 0..1 CodeableConcept The route of administration.
... status 1..1 code The status of this vaccination record entry
... statusReason 0..1 CodeableConcept The reason for the status e.g. 'not completed because...'
Binding: BeVSVaccinationStatusReason (required): Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

... reaction 0..1 BackboneElement Reaction to the immunization - cfr. AllergyIntolerance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reactionDate 1..1 dateTime date of the reaction
.... manifestation 0..1 Reference() reference to the observation of the reaction
... doseQuantity 0..1 BackboneElement The number or quantity of product(s) that was administered - e.g. 1/2 dose
... note 0..1 Attachment Additional notes for the vaccination.
... site 1..1 CodeableConcept The body site where the vaccination entered the body
... identifier 0..* Identifier The business identifier(s) for the vaccination entry
... bodyLaterality 0..1 CodeableConcept The side of the body (for sites that occur on both sides of the body)
... location 0..1 Reference() The location where the immunization is performed.
... locationType 0..1 CodeableConcept The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
... cause 0..1 CodeableConcept Is the vaccination due to pre or post exposition prophylaxis?
... stockOrigin 0..1 Reference(Location) The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
... stockFundingEntity 0..1 Reference(Organization) The entity that is funding the provision of the vaccines

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-vaccination.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. be-model-vaccination 0..* Element
Elements defined in Ancestors:@id, extension
BeModelVaccination
Instances of this logical model are not marked to be the target of a Reference
... @id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded
... vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination
... recorder 1..1 Reference(Practitioner) The professional that recorded the administration of the vaccine
... performer 0..1 Reference(Practitioner) The professional that administered the medication
... vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
... vaccinationDate[x] 0..1 The date and time when the vaccination has been administered
.... vaccinationDateDateTime dateTime
.... vaccinationDateString string
... administeredProduct 0..1 BackboneElement The details of the product that was administered.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... product[x] 0..1 The actual product that was administered. This should be a product code or a reference to an actual Medication resource
..... productReference Reference(Any)
..... productCodeableConcept CodeableConcept
.... lotNumber 0..1 string The lot number
.... expirationDate 0..1 date The expiration date of the product.
... route 0..1 CodeableConcept The route of administration.
... status 1..1 code The status of this vaccination record entry
... statusReason 0..1 CodeableConcept The reason for the status e.g. 'not completed because...'
Binding: BeVSVaccinationStatusReason (required): Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

... reaction 0..1 BackboneElement Reaction to the immunization - cfr. AllergyIntolerance
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reactionDate 1..1 dateTime date of the reaction
.... manifestation 0..1 Reference() reference to the observation of the reaction
... doseQuantity 0..1 BackboneElement The number or quantity of product(s) that was administered - e.g. 1/2 dose
... note 0..1 Attachment Additional notes for the vaccination.
... site 1..1 CodeableConcept The body site where the vaccination entered the body
... identifier 0..* Identifier The business identifier(s) for the vaccination entry
... bodyLaterality 0..1 CodeableConcept The side of the body (for sites that occur on both sides of the body)
... location 0..1 Reference() The location where the immunization is performed.
... locationType 0..1 CodeableConcept The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
... cause 0..1 CodeableConcept Is the vaccination due to pre or post exposition prophylaxis?
... stockOrigin 0..1 Reference(Location) The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
... stockFundingEntity 0..1 Reference(Organization) The entity that is funding the provision of the vaccines

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
be-model-vaccination.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG

This structure is derived from Element

Summary

Mandatory: 0 element(7 nested mandatory elements)

 

Other representations of profile: CSV, Excel