This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Definitions for the be-model-immunization Profile.
1. BEImmunization | |
Definition | This is the base resource type for everything. |
Control | 0..* |
2. BEImmunization.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | string |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
3. BEImmunization.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
4. BEImmunization.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
5. BEImmunization.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHOULD be taken from CommonLanguages Max Binding: AllLanguages |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. BEImmunization.identifier | |
Definition | The business identifier(s) for the immunization 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..1 |
Type | Identifier |
7. BEImmunization.status | |
Definition | The status of the immunization record entry - whether it is active, entered in error, etc. |
Control | 1..1 |
Type | code(code) |
8. BEImmunization.statusReason | |
Definition | Supporting reason for status information..... |
Control | 0..1 |
Type | CodeableConcept(CodeableConcept) |
9. BEImmunization.patient | |
Definition | The patient that has received the immunization. |
Control | 1..1 |
Type | Reference(BePatient) |
10. BEImmunization.vaccineCode | |
Definition | The target of the immunization - the disease that the immunization action is protecting against. This should be a coded value. |
Control | 0..1 |
Type | CodeableConcept |
11. BEImmunization.dateTime | |
Definition | The date and/or time when the immunization administration has been recorded |
Control | 0..1 |
Type | dateTime(dateTime) |
12. BEImmunization.immunizationPlan | |
Definition | The patient-specific order or recommendation for the immunization, for example a prescription or a request for immunization for a patient by a physician, for example for optional vaccines. |
Control | 0..1 |
Type | Reference |
13. BEImmunization.protocol | |
Definition | The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling. For example 'Basisvaccinatieschema' |
Control | 0..1 |
Type | Reference |
14. BEImmunization.type | |
Definition | The type of immunization action - for example first dose or reinforcement. |
Control | 0..1 |
Type | code |
15. BEImmunization.reporter | |
Definition | The professional that recorded the administration of the vaccine. |
Control | 0..1 |
Type | Reference(BePractitioner) |
16. BEImmunization.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 | 0..1 |
Type | dateTime |
17. BEImmunization.performer | |
Definition | The professional that administered the medication. |
Control | 0..1 |
Type | Reference(BePractitioner) |
18. BEImmunization.route | |
Definition | The route of administration for the vaccine. This can be free text (not desired) or a code |
Control | 0..1 |
Type | CodeableConcept |
19. BEImmunization.administeredProduct | |
Control | 0..1 |
Type | BackboneElement |
20. BEImmunization.administeredProduct.product | |
Control | 0..1 |
Type | CodeableReference |
21. BEImmunization.administeredProduct.lotNumber | |
Definition | The lot number |
Control | 0..1 |
Type | string |
22. BEImmunization.administeredProduct.expirationDate | |
Definition | The expiration date of the product. |
Control | 0..1 |
Type | Date |
23. BEImmunization.location | |
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' or 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 | CodeableReference |
24. BEImmunization.note | |
Definition | Additional notes for the immunization |
Control | 0..1 |
Type | Attachment(Attachment) |