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

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

Logical Model: BeModelVaccination - Detailed Descriptions

Active as of 2024-09-04

Definitions for the be-model-vaccination logical model.

Guidance on how to interpret the contents of this table can be found here

0. be-model-vaccination
Definition

BeModelVaccination

ShortBeModelVaccination
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. be-model-vaccination.recorded
Definition

The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.

ShortThe date and time when the administration of the vaccine was recorded
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. be-model-vaccination.patient
Definition

The patient that has received the vaccination.

ShortThe patient that received vaccination.
Control1..1
TypeReference(Patient)
6. be-model-vaccination.vaccinationRequest
Definition

The patient-specific order or recommendation for the vaccination, for example a prescription or a request for vaccination for a patient by a physician, for example for optional vaccines.

ShortThe patient-specific order or recommendation for the vaccination
Control0..1
TypeReference
8. be-model-vaccination.recorder
Definition

The professional that recorded the administration of the vaccine.

ShortThe professional that recorded the administration of the vaccine
Control1..1
TypeReference(Practitioner)
10. be-model-vaccination.performer
Definition

The professional that administered the medication. Use code "unknown" if not known.

ShortThe professional that administered the medication
Control0..1
TypeReference(Practitioner)
12. be-model-vaccination.vaccineCode
Definition

The vaccine code - a type of vaccine, typically identified by the disease(s) it covers. For example MMR, HPV, Tetanus, DTPa. This should be a coded value.

ShortThe vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Control1..1
TypeCodeableConcept
14. be-model-vaccination.vaccinationDate[x]
Definition

The date and/or time when the vaccine administration has been administered or presumed to be administered

ShortThe date and time when the vaccination has been administered
Control0..1
TypeChoice of: dateTime, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. be-model-vaccination.administeredProduct
Definition

The details of the product that was administered

ShortThe details of the product that was administered.
Control0..1
TypeBackboneElement
18. be-model-vaccination.administeredProduct.product[x]
Definition

The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)

ShortThe actual product that was administered. This should be a product code or a reference to an actual Medication resource
Comments

In the case where the product is not known, use code "unknown"

Control0..1
TypeChoice of: Reference, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
20. be-model-vaccination.administeredProduct.lotNumber
Definition

The lot number

ShortThe lot number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. be-model-vaccination.administeredProduct.expirationDate
Definition

The expiration date of the product.

ShortThe expiration date of the product.
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. be-model-vaccination.route
Definition

The route of administration for the vaccine. This can be free text (not desired) or a code

ShortThe route of administration.
Control0..1
TypeCodeableConcept
26. be-model-vaccination.status
Definition

The status of the vaccination record entry - whether it is active, entered in error, etc.

ShortThe status of this vaccination record entry
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. be-model-vaccination.statusReason
Definition

Supporting reason for status information.

ShortThe reason for the status e.g. 'not completed because...'
Control0..1
BindingThe codes SHALL be taken from BeVSVaccinationStatusReason
(required to https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason)

Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine

TypeCodeableConcept
30. be-model-vaccination.reaction
Definition

Reaction to the immunization - cfr. AllergyIntolerance

ShortReaction to the immunization - cfr. AllergyIntolerance
Control0..1
TypeBackboneElement
32. be-model-vaccination.reaction.reactionDate
Definition

date of the reaction

Shortdate of the reaction
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. be-model-vaccination.reaction.manifestation
Definition

reference to the observation of the reaction

Shortreference to the observation of the reaction
Control0..1
TypeReference
36. be-model-vaccination.doseQuantity
Definition

The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc.

ShortThe number or quantity of product(s) that was administered - e.g. 1/2 dose
Control0..1
TypeBackboneElement
38. be-model-vaccination.note
Definition

Additional notes for the vaccination

ShortAdditional notes for the vaccination.
Control0..1
TypeAttachment
40. be-model-vaccination.site
Definition

The body site where the vaccination entered the body

ShortThe body site where the vaccination entered the body
Control1..1
TypeCodeableConcept
42. be-model-vaccination.identifier
Definition

The business identifier(s) for the vaccination entry - This is an optional attribute, used for example to track an entry throughout its lifecycle, or across vaults.

ShortThe business identifier(s) for the vaccination entry
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
44. be-model-vaccination.bodyLaterality
Definition

The side of the body (for sites that occur on both sides of the body)

ShortThe side of the body (for sites that occur on both sides of the body)
Control0..1
TypeCodeableConcept
46. be-model-vaccination.location
Definition

a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai'

ShortThe location where the immunization is performed.
Control0..1
TypeReference
48. be-model-vaccination.locationType
Definition

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'

ShortThe 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'
Control0..1
TypeCodeableConcept
50. be-model-vaccination.cause
Definition

Is the vaccination due to pre or post exposition prophylaxis?

ShortIs the vaccination due to pre or post exposition prophylaxis?
Control0..1
TypeCodeableConcept
52. be-model-vaccination.stockOrigin
Definition

The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...

ShortThe stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
Control0..1
TypeReference(Location)
54. be-model-vaccination.stockFundingEntity
Definition

The entity that is funding the provision of the vaccines

ShortThe entity that is funding the provision of the vaccines
Control0..1
TypeReference(Organization)