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

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.3: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: BeModelVaccinationReduced - Detailed Descriptions

Active as of 2023-06-26

Definitions for the be-model-vaccination-reduced logical model.

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

1. be-model-vaccination-reduced
Control0..?
Logical ModelThis logical model cannot be the target of a reference
2. be-model-vaccination-reduced.patient
Definition

The patient that has received the vaccination.

Control1..1
TypeReference(Patient)
3. be-model-vaccination-reduced.performer
Definition

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

Control1..1
TypeReference(Practitioner)
4. be-model-vaccination-reduced.administeredProduct
Definition

The details of the product that was administered

Control1..1
TypeBackboneElement
5. be-model-vaccination-reduced.administeredProduct.product
Definition

The code of the product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml).

Control1..1
TypeCoding
6. be-model-vaccination-reduced.administeredProduct.description
Definition

The description of the product that was administered.

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
7. be-model-vaccination-reduced.administeredProduct.lotNumber
Definition

The lot number

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-vaccination-reduced.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
9. be-model-vaccination-reduced.vaccinationDate[x]
Definition

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

Control0..1
TypeChoice of: dateTime, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. be-model-vaccination-reduced.recorded
Definition

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

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
11. be-model-vaccination-reduced.doseQuantity
Definition

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

Control0..1
TypeBackboneElement
12. be-model-vaccination-reduced.targetDisease
Definition

The target disease for this vaccination.

Control1..1
TypeCodeableConcept
13. be-model-vaccination-reduced.sideEffects
Definition

Any noted side effect from this vaccination.

Control0..1
TypeAttachment
14. be-model-vaccination-reduced.cause
Definition

Is the vaccination due to pre or post exposition prophylaxis?

Control0..1
TypeCodeableConcept

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

1. be-model-vaccination-reduced
Definition

Base definition for all elements in a resource.

Control0..* This element is affected by the following invariants: ele-1
Logical ModelThis logical model cannot be the target of a reference
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. be-model-vaccination-reduced.patient
Definition

The patient that has received the vaccination.

Control1..1
TypeReference(Patient)
3. be-model-vaccination-reduced.performer
Definition

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

Control1..1
TypeReference(Practitioner)
4. be-model-vaccination-reduced.administeredProduct
Definition

The details of the product that was administered

Control1..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. be-model-vaccination-reduced.administeredProduct.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined 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())
6. be-model-vaccination-reduced.administeredProduct.product
Definition

The code of the product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml).

Control1..1
TypeCoding
7. be-model-vaccination-reduced.administeredProduct.description
Definition

The description of the product that was administered.

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. be-model-vaccination-reduced.administeredProduct.lotNumber
Definition

The lot number

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
9. be-model-vaccination-reduced.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
10. be-model-vaccination-reduced.vaccinationDate[x]
Definition

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

Control0..1
TypeChoice of: dateTime, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
11. be-model-vaccination-reduced.recorded
Definition

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

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. be-model-vaccination-reduced.doseQuantity
Definition

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

Control0..1
TypeBackboneElement
13. be-model-vaccination-reduced.targetDisease
Definition

The target disease for this vaccination.

Control1..1
TypeCodeableConcept
14. be-model-vaccination-reduced.sideEffects
Definition

Any noted side effect from this vaccination.

Control0..1
TypeAttachment
15. be-model-vaccination-reduced.cause
Definition

Is the vaccination due to pre or post exposition prophylaxis?

Control0..1
TypeCodeableConcept

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

1. be-model-vaccination-reduced
Definition

Base definition for all elements in a resource.

Control0..* This element is affected by the following invariants: ele-1
Logical ModelThis logical model cannot be the target of a reference
2. be-model-vaccination-reduced.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. be-model-vaccination-reduced.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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, 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.

InvariantsDefined 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())
SlicingThis element introduces a set of slices on be-model-vaccination-reduced.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. be-model-vaccination-reduced.patient
Definition

The patient that has received the vaccination.

Control1..1
TypeReference(Patient)
5. be-model-vaccination-reduced.performer
Definition

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

Control1..1
TypeReference(Practitioner)
6. be-model-vaccination-reduced.administeredProduct
Definition

The details of the product that was administered

Control1..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. be-model-vaccination-reduced.administeredProduct.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
8. be-model-vaccination-reduced.administeredProduct.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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, 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.

InvariantsDefined 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())
SlicingThis element introduces a set of slices on be-model-vaccination-reduced.administeredProduct.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. be-model-vaccination-reduced.administeredProduct.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Control0..*
TypeExtension
Is Modifiertrue
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
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.

InvariantsDefined 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())
10. be-model-vaccination-reduced.administeredProduct.product
Definition

The code of the product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml).

Control1..1
TypeCoding
11. be-model-vaccination-reduced.administeredProduct.description
Definition

The description of the product that was administered.

Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. be-model-vaccination-reduced.administeredProduct.lotNumber
Definition

The lot number

Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
13. be-model-vaccination-reduced.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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
14. be-model-vaccination-reduced.vaccinationDate[x]
Definition

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

Control0..1
TypeChoice of: dateTime, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
15. be-model-vaccination-reduced.recorded
Definition

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

Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. be-model-vaccination-reduced.doseQuantity
Definition

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

Control0..1
TypeBackboneElement
17. be-model-vaccination-reduced.targetDisease
Definition

The target disease for this vaccination.

Control1..1
TypeCodeableConcept
18. be-model-vaccination-reduced.sideEffects
Definition

Any noted side effect from this vaccination.

Control0..1
TypeAttachment
19. be-model-vaccination-reduced.cause
Definition

Is the vaccination due to pre or post exposition prophylaxis?

Control0..1
TypeCodeableConcept