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

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.1.2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: BeAdministeredProduct

Official URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct Version: 1.1.2
Active as of 2025-11-27 Maturity Level: 1 Computable Name: BeAdministeredProduct

The product administered

Context of Use

    This extension may be used on the following element(s)

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension BeAdministeredProduct
... Slices for extension Content/Rules for all slices
.... extension:reference S 0..1 Extension Reference to the administered product as a medication
..... extension 0..0 Extension
..... url 1..1 uri "reference"
..... value[x] 0..1 Reference(Medication) Value of extension
.... extension:coded S 0..1 Extension Administered product as a code
..... extension 0..0 Extension
..... url 1..1 uri "coded"
..... value[x] 0..1 CodeableConcept Value of extension
.... extension:lotNumber S 0..1 Extension Lot number of the administered product, if it is a code
..... extension 0..0 Extension
..... url 1..1 uri "lotNumber"
..... value[x] 0..1 string Value of extension
.... extension:expirationDate S 0..1 Extension Expiration date of the administered product, if it is a code
..... extension 0..0 Extension
..... url 1..1 uri "expirationDate"
..... value[x] 0..1 date Value of extension
... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct"
... value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension BeAdministeredProduct
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:reference S 0..1 Extension Reference to the administered product as a medication
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "reference"
..... value[x] 0..1 Reference(Medication) Value of extension
.... extension:coded S 0..1 Extension Administered product as a code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "coded"
..... value[x] 0..1 CodeableConcept Value of extension
.... extension:lotNumber S 0..1 Extension Lot number of the administered product, if it is a code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "lotNumber"
..... value[x] 0..1 string Value of extension
.... extension:expirationDate S 0..1 Extension Expiration date of the administered product, if it is a code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "expirationDate"
..... value[x] 0..1 date Value of extension
... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The product administered

  • reference: Reference: An Extension
  • coded: CodeableConcept: An Extension
  • lotNumber: string: An Extension
  • expirationDate: date: An Extension

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension BeAdministeredProduct
... Slices for extension Content/Rules for all slices
.... extension:reference S 0..1 Extension Reference to the administered product as a medication
..... extension 0..0 Extension
..... url 1..1 uri "reference"
..... value[x] 0..1 Reference(Medication) Value of extension
.... extension:coded S 0..1 Extension Administered product as a code
..... extension 0..0 Extension
..... url 1..1 uri "coded"
..... value[x] 0..1 CodeableConcept Value of extension
.... extension:lotNumber S 0..1 Extension Lot number of the administered product, if it is a code
..... extension 0..0 Extension
..... url 1..1 uri "lotNumber"
..... value[x] 0..1 string Value of extension
.... extension:expirationDate S 0..1 Extension Expiration date of the administered product, if it is a code
..... extension 0..0 Extension
..... url 1..1 uri "expirationDate"
..... value[x] 0..1 date Value of extension
... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct"
... value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension BeAdministeredProduct
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:reference S 0..1 Extension Reference to the administered product as a medication
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "reference"
..... value[x] 0..1 Reference(Medication) Value of extension
.... extension:coded S 0..1 Extension Administered product as a code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "coded"
..... value[x] 0..1 CodeableConcept Value of extension
.... extension:lotNumber S 0..1 Extension Lot number of the administered product, if it is a code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "lotNumber"
..... value[x] 0..1 string Value of extension
.... extension:expirationDate S 0..1 Extension Expiration date of the administered product, if it is a code
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "expirationDate"
..... value[x] 0..1 date Value of extension
... url 1..1 uri "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: The product administered

  • reference: Reference: An Extension
  • coded: CodeableConcept: An Extension
  • lotNumber: string: An Extension
  • expirationDate: date: An Extension

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()