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

HL7 Belgium Vaccination (Patient Dossier), published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/vaccination/ and changes regularly. See the Directory of published versions

Logical Model: BeModelVaccinationReduced - Detailed Descriptions

Draft as of 2024-09-09

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

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

0. be-model-vaccination-reduced
Definition

BeModelVaccinationReduced

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

The patient that has received the vaccination.

ShortThe patient that received vaccination.
Control1..1
TypeReference(Patient)
4. be-model-vaccination-reduced.performer
Definition

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

ShortThe professional that administered the medication
Control1..1
TypeReference(Practitioner)
6. be-model-vaccination-reduced.administeredProduct
Definition

The details of the product that was administered

ShortThe details of the product that was administered.
Control1..1
TypeBackboneElement
8. 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).

ShortThe code of the product that was administered.
Control1..1
TypeCoding
10. be-model-vaccination-reduced.administeredProduct.description
Definition

The description of the product that was administered.

ShortThe 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

ShortThe lot number
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. 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.

ShortThe business identifier(s) for the vaccination entry
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
16. be-model-vaccination-reduced.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
18. 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.

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
20. be-model-vaccination-reduced.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
22. be-model-vaccination-reduced.targetDisease
Definition

The target disease for this vaccination.

ShortThe target disease for this vaccination.
Control1..1
TypeCodeableConcept
24. be-model-vaccination-reduced.sideEffects
Definition

Any noted side effect from this vaccination.

ShortAny noted side effect from this vaccination.
Control0..1
TypeAttachment
26. be-model-vaccination-reduced.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

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

0. be-model-vaccination-reduced
Definition

BeModelVaccinationReduced


Base definition for all elements in a resource.

ShortBeModelVaccinationReducedBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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.

ShortThe patient that received vaccination.
Control1..1
TypeReference(Patient)
4. be-model-vaccination-reduced.performer
Definition

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

ShortThe professional that administered the medication
Control1..1
TypeReference(Practitioner)
6. be-model-vaccination-reduced.administeredProduct
Definition

The details of the product that was administered

ShortThe details of the product that was administered.
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. 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).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
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
Invariantsele-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).

ShortThe code of the product that was administered.
Control1..1
TypeCoding
12. be-model-vaccination-reduced.administeredProduct.description
Definition

The description of the product that was administered.

ShortThe description of the product that was administered.
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. be-model-vaccination-reduced.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
16. 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.

ShortThe business identifier(s) for the vaccination entry
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
18. be-model-vaccination-reduced.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
20. 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.

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
22. be-model-vaccination-reduced.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
24. be-model-vaccination-reduced.targetDisease
Definition

The target disease for this vaccination.

ShortThe target disease for this vaccination.
Control1..1
TypeCodeableConcept
26. be-model-vaccination-reduced.sideEffects
Definition

Any noted side effect from this vaccination.

ShortAny noted side effect from this vaccination.
Control0..1
TypeAttachment
28. be-model-vaccination-reduced.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

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

0. be-model-vaccination-reduced
Definition

BeModelVaccinationReduced

ShortBeModelVaccinationReduced
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. 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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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 areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. be-model-vaccination-reduced.patient
    Definition

    The patient that has received the vaccination.

    ShortThe patient that received vaccination.
    Control1..1
    TypeReference(Patient)
    8. be-model-vaccination-reduced.performer
    Definition

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

    ShortThe professional that administered the medication
    Control1..1
    TypeReference(Practitioner)
    10. be-model-vaccination-reduced.administeredProduct
    Definition

    The details of the product that was administered

    ShortThe details of the product that was administered.
    Control1..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. 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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    14. 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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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 areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 16. 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).

      ShortExtensions that cannot be ignored even if unrecognized
      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      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
      Invariantsele-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())
      18. 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).

      ShortThe code of the product that was administered.
      Control1..1
      TypeCoding
      20. be-model-vaccination-reduced.administeredProduct.description
      Definition

      The description of the product that was administered.

      ShortThe description of the product that was administered.
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. be-model-vaccination-reduced.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
      24. 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.

      ShortThe business identifier(s) for the vaccination entry
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      TypeIdentifier
      26. be-model-vaccination-reduced.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
      28. 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.

      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
      30. be-model-vaccination-reduced.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
      32. be-model-vaccination-reduced.targetDisease
      Definition

      The target disease for this vaccination.

      ShortThe target disease for this vaccination.
      Control1..1
      TypeCodeableConcept
      34. be-model-vaccination-reduced.sideEffects
      Definition

      Any noted side effect from this vaccination.

      ShortAny noted side effect from this vaccination.
      Control0..1
      TypeAttachment
      36. be-model-vaccination-reduced.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