HL7 Belgium Vaccination (Patient Dossier)
1.0.1 - STU

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.1: Trial Use) based on FHIR R4. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions

Logical Model: BeModelVaccinationReduced - Detailed Descriptions

Active as of 2022-10-19

Definitions for the BeModelVaccinationReduced logical model.

1. BeModelVaccinationReduced
Control0..?
2. BeModelVaccinationReduced.patient
Definition

The patient that has received the vaccination.

Control1..1
TypeReference(Patient))
3. BeModelVaccinationReduced.performer
Definition

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

Control1..1
TypeReference(Practitioner))
4. BeModelVaccinationReduced.administeredProduct
Definition

The details of the product that was administered

Control1..1
TypeBackboneElement
5. BeModelVaccinationReduced.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. BeModelVaccinationReduced.administeredProduct.description
Definition

The description of the product that was administered.

Control1..1
Typestring
7. BeModelVaccinationReduced.administeredProduct.lotNumber
Definition

The lot number

Control0..1
Typestring
8. BeModelVaccinationReduced.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. BeModelVaccinationReduced.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]
10. BeModelVaccinationReduced.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
11. BeModelVaccinationReduced.doseQuantity
Definition

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

Control0..1
TypeBackboneElement
12. BeModelVaccinationReduced.targetDisease
Definition

The target disease for this vaccination.

Control1..1
TypeCodeableConcept
13. BeModelVaccinationReduced.sideEffects
Definition

Any noted side effect from this vaccination.

Control0..1
TypeAttachment
14. BeModelVaccinationReduced.cause
Control0..1
TypeCodeableConcept
1. BeModelVaccinationReduced
Definition

Base definition for all elements in a resource.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. BeModelVaccinationReduced.patient
Definition

The patient that has received the vaccination.

Control1..1
TypeReference(Patient))
3. BeModelVaccinationReduced.performer
Definition

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

Control1..1
TypeReference(Practitioner))
4. BeModelVaccinationReduced.administeredProduct
Definition

The details of the product that was administered

Control1..1
TypeBackboneElement
5. BeModelVaccinationReduced.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. BeModelVaccinationReduced.administeredProduct.description
Definition

The description of the product that was administered.

Control1..1
Typestring
7. BeModelVaccinationReduced.administeredProduct.lotNumber
Definition

The lot number

Control0..1
Typestring
8. BeModelVaccinationReduced.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. BeModelVaccinationReduced.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]
10. BeModelVaccinationReduced.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
11. BeModelVaccinationReduced.doseQuantity
Definition

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

Control0..1
TypeBackboneElement
12. BeModelVaccinationReduced.targetDisease
Definition

The target disease for this vaccination.

Control1..1
TypeCodeableConcept
13. BeModelVaccinationReduced.sideEffects
Definition

Any noted side effect from this vaccination.

Control0..1
TypeAttachment
14. BeModelVaccinationReduced.cause
Control0..1
TypeCodeableConcept
1. BeModelVaccinationReduced
Definition

Base definition for all elements in a resource.

Control0..* This element is affected by the following invariants: ele-1
2. BeModelVaccinationReduced.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.
3. BeModelVaccinationReduced.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
Alternate Namesextensionsuser 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 BeModelVaccinationReduced.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. BeModelVaccinationReduced.patient
Definition

The patient that has received the vaccination.

Control1..1
TypeReference(Patient))
5. BeModelVaccinationReduced.performer
Definition

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

Control1..1
TypeReference(Practitioner))
6. BeModelVaccinationReduced.administeredProduct
Definition

The details of the product that was administered

Control1..1
TypeBackboneElement
7. BeModelVaccinationReduced.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
8. BeModelVaccinationReduced.administeredProduct.description
Definition

The description of the product that was administered.

Control1..1
Typestring
9. BeModelVaccinationReduced.administeredProduct.lotNumber
Definition

The lot number

Control0..1
Typestring
10. BeModelVaccinationReduced.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
11. BeModelVaccinationReduced.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]
12. BeModelVaccinationReduced.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
13. BeModelVaccinationReduced.doseQuantity
Definition

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

Control0..1
TypeBackboneElement
14. BeModelVaccinationReduced.targetDisease
Definition

The target disease for this vaccination.

Control1..1
TypeCodeableConcept
15. BeModelVaccinationReduced.sideEffects
Definition

Any noted side effect from this vaccination.

Control0..1
TypeAttachment
16. BeModelVaccinationReduced.cause
Control0..1
TypeCodeableConcept