HL7 Belgium Vaccination (Patient Dossier)
1.0.0 - STU
This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.0: Trial Use) 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
| Active as of 2022-05-31 |
Definitions for the BeModelVaccination logical model.
| 1. BeModelVaccination | |
| Definition | Base definition for all elements in a resource. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 2. BeModelVaccination.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 3. BeModelVaccination.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on BeModelVaccination.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. BeModelVaccination.recorded | |
| Definition | The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori. |
| Control | 1..1 |
| Type | dateTime |
| 5. BeModelVaccination.patient | |
| Definition | The patient that has received the vaccination. |
| Control | 1..1 |
| Type | Reference(Patient) |
| 6. BeModelVaccination.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. |
| Control | 0..1 |
| Type | Reference |
| 7. BeModelVaccination.recorder | |
| Definition | The professional that recorded the administration of the vaccine. |
| Control | 1..1 |
| Type | Reference(Practitioner) |
| 8. BeModelVaccination.performer | |
| Definition | The professional that administered the medication. Use code "unknown" if not known. |
| Control | 0..1 |
| Type | Reference(Practitioner) |
| 9. BeModelVaccination.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. |
| Control | 1..1 |
| Type | CodeableConcept |
| 10. BeModelVaccination.vaccinationDate[x] | |
| Definition | The date and/or time when the vaccine administration has been administered or presumed to be administered |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 11. BeModelVaccination.administeredProduct | |
| Definition | The details of the product that was administered |
| Control | 0..1 |
| Type | BackboneElement |
| 12. BeModelVaccination.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) |
| Control | 0..1 |
| Type | Choice of: Reference, CodeableConcept |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Comments | In the case where the product is not known, use code "unknown" |
| 13. BeModelVaccination.administeredProduct.lotNumber | |
| Definition | The lot number |
| Control | 0..1 |
| Type | string |
| 14. BeModelVaccination.administeredProduct.expirationDate | |
| Definition | The expiration date of the product. |
| Control | 0..1 |
| Type | date |
| 15. BeModelVaccination.route | |
| Definition | The route of administration for the vaccine. This can be free text (not desired) or a code |
| Control | 0..1 |
| Type | CodeableConcept |
| 16. BeModelVaccination.status | |
| Definition | The status of the vaccination record entry - whether it is active, entered in error, etc. |
| Control | 1..1 |
| Type | code |
| 17. BeModelVaccination.statusReason | |
| Definition | Supporting reason for status information. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from BeVSVaccinationStatusReason Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine |
| Type | CodeableConcept |
| 18. BeModelVaccination.reaction | |
| Definition | Reaction to the immunization - cfr. AllergyIntolerance |
| Control | 0..1 |
| Type | BackboneElement |
| 19. BeModelVaccination.reaction.reactionDate | |
| Definition | date of the reaction |
| Control | 1..1 |
| Type | dateTime |
| 20. BeModelVaccination.reaction.manifestation | |
| Definition | reference to the observation of the reaction |
| Control | 0..1 |
| Type | Reference |
| 21. BeModelVaccination.doseQuantity | |
| Definition | The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc. |
| Control | 0..1 |
| Type | BackboneElement |
| 22. BeModelVaccination.note | |
| Definition | Additional notes for the vaccination |
| Control | 0..1 |
| Type | Attachment |
| 23. BeModelVaccination.site | |
| Definition | The body site where the vaccination entered the body |
| Control | 1..1 |
| Type | CodeableConcept |
| 24. BeModelVaccination.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. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| 25. BeModelVaccination.bodyLaterality | |
| Definition | The side of the body (for sites that occur on both sides of the body) |
| Control | 0..1 |
| Type | CodeableConcept |
| 26. BeModelVaccination.location | |
| Definition | a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' |
| Control | 0..1 |
| Type | Reference |
| 27. BeModelVaccination.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' |
| Control | 0..1 |
| Type | CodeableConcept |