be-model-vaccination-reduced
type: StructureDefinition
node role: treeRoot
id:
  v: be-model-vaccination-reduced
language:
  v: en
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition be-model-vaccination-reduced Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> be-model-vaccination-reduced 0..* Element BeModelVaccinationReduced Elements defined in Ancestors:@id, <a href="http://hl7.org/fhir/R4/datatypes.html#Element" title="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.">extension #xD; patient 1..1 Reference(Patient) The patient that received vaccination. #xD; performer 1..1 Reference(Practitioner) The professional that administered the medication #xD; administeredProduct 1..1 BackboneElement The details of the product that was administered. #xD; product 1..1 Coding The code of the product that was administered. #xD; description 1..1 string The description of the product that was administered. #xD; lotNumber 0..1 string The lot number #xD; identifier 0..1 Identifier The business identifier(s) for the vaccination entry #xD; vaccinationDate[x] 0..1 The date and time when the vaccination has been administered #xD; <span title="Base StructureDefinition for dateTime Type: A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.">vaccinationDateDateTime dateTime #xD; vaccinationDateString string #xD; recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded #xD; doseQuantity 0..1 BackboneElement The numbe…
url:
  v: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination-reduced
  l: be-model-vaccination-reduced
version:
  v: 1.1.3
name:
  v: BeModelVaccinationReduced
status:
  v: active
date:
  v: 2026-06-05T14:47:47+02:00
publisher:
  v: eHealth Platform
contact:
  name:
    v: eHealth Platform
  telecom:
    system:
      v: url
    value:
      v: http://www.ehealth.fgov.be/
  telecom:
    system:
      v: email
contact:
  name:
    v: Message Structure
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: Reduced Logical Model for vaccination
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
      l: 3166
    code:
      v: BE
    display:
      v: Belgium
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination-reduced
  l: be-model-vaccination-reduced
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Element
  l: Element
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: be-model-vaccination-reduced
    path:
      v: be-model-vaccination-reduced
    short:
      v: BeModelVaccinationReduced
    definition:
      v: BeModelVaccinationReduced
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: be-model-vaccination-reduced.id
    path:
      v: be-model-vaccination-reduced.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: Url
      code:
        v: http://hl7.org/fhirpath/System.String
        l: System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: be-model-vaccination-reduced.extension
    path:
      v: be-model-vaccination-reduced.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations
    definition:
      v: 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.
    comment:
      v: 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.
    alias:
      v: extensions
    alias:
      v: user content
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element.extension
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Extension
        l: Extension
    constraint:
      key:
        v: ele-1
      severity:
        v: error

Url
v: string
l: string

v: value

v: url

v: All FHIR elements must have a @value or children

v: hasValue() or (children().count() > id.count())

v: @value|f:*|h:div

key:
  v: ext-1
severity:
  v: error
human:
  v: Must have either extensions or value[x], not both
expression:
  v: extension.exists() != value.exists()
xpath:
  v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
source:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  l: Extension

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: be-model-vaccination-reduced.patient
path:
  v: be-model-vaccination-reduced.patient
short:
  v: The patient that received vaccination.
definition:
  v: The patient that has received the vaccination.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient

id:
  v: be-model-vaccination-reduced.performer
path:
  v: be-model-vaccination-reduced.performer
short:
  v: The professional that administered the medication
definition:
  v: The professional that administered the medication. Use code "unknown" if not known.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.performer
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner

id:
  v: be-model-vaccination-reduced.administeredProduct
path:
  v: be-model-vaccination-reduced.administeredProduct
short:
  v: The details of the product that was administered.
definition:
  v: The details of the product that was administered
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.administeredProduct
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: be-model-vaccination-reduced.administeredProduct.id
path:
  v: be-model-vaccination-reduced.administeredProduct.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: be-model-vaccination-reduced.administeredProduct.extension
path:
  v: be-model-vaccination-reduced.administeredProduct.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: be-model-vaccination-reduced.administeredProduct.modifierExtension
path:
  v: be-model-vaccination-reduced.administeredProduct.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: be-model-vaccination-reduced.administeredProduct.product
path:
  v: be-model-vaccination-reduced.administeredProduct.product
short:
  v: The code of the product that was administered.
definition:
  v: 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).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.administeredProduct.product
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
    l: Coding

id:
  v: be-model-vaccination-reduced.administeredProduct.description
path:
  v: be-model-vaccination-reduced.administeredProduct.description
short:
  v: The description of the product that was administered.
definition:
  v: The description of the product that was administered.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.administeredProduct.description
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: be-model-vaccination-reduced.administeredProduct.lotNumber
path:
  v: be-model-vaccination-reduced.administeredProduct.lotNumber
short:
  v: The lot number
definition:
  v: The lot number
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.administeredProduct.lotNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: be-model-vaccination-reduced.identifier
path:
  v: be-model-vaccination-reduced.identifier
short:
  v: The business identifier(s) for the vaccination entry
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: be-model-vaccination-reduced.vaccinationDate[x]
path:
  v: be-model-vaccination-reduced.vaccinationDate[x]
short:
  v: The date and time when the vaccination has been administered
definition:
  v: The date and/or time when the vaccine administration has been administered or presumed to be administered
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.vaccinationDate[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: string
    l: string

id:
  v: be-model-vaccination-reduced.recorded
path:
  v: be-model-vaccination-reduced.recorded
short:
  v: The date and time when the administration of the vaccine was recorded
definition:
  v: The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.recorded
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: be-model-vaccination-reduced.doseQuantity
path:
  v: be-model-vaccination-reduced.doseQuantity
short:
  v: The number or quantity of product(s) that was administered - e.g. 1/2 dose
definition:
  v: The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.doseQuantity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement

id:
  v: be-model-vaccination-reduced.targetDisease
path:
  v: be-model-vaccination-reduced.targetDisease
short:
  v: The target disease for this vaccination.
definition:
  v: The target disease for this vaccination.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.targetDisease
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: be-model-vaccination-reduced.sideEffects
path:
  v: be-model-vaccination-reduced.sideEffects
short:
  v: Any noted side effect from this vaccination.
definition:
  v: Any noted side effect from this vaccination.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.sideEffects
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Attachment
    l: Attachment

id:
  v: be-model-vaccination-reduced.cause
path:
  v: be-model-vaccination-reduced.cause
short:
  v: Is the vaccination due to pre or post exposition prophylaxis?
definition:
  v: Is the vaccination due to pre or post exposition prophylaxis?
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination-reduced.cause
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

element:
  id:
    v: be-model-vaccination-reduced
  path:
    v: be-model-vaccination-reduced
  short:
    v: BeModelVaccinationReduced
  definition:
    v: BeModelVaccinationReduced
element:
  id:
    v: be-model-vaccination-reduced.patient
  path:
    v: be-model-vaccination-reduced.patient
  short:
    v: The patient that received vaccination.
  definition:
    v: The patient that has received the vaccination.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Patient
      l: Patient
element:
  id:
    v: be-model-vaccination-reduced.performer
  path:
    v: be-model-vaccination-reduced.performer
  short:
    v: The professional that administered the medication
  definition:
    v: The professional that administered the medication. Use code "unknown" if not known.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Practitioner
      l: Practitioner
element:
  id:
    v: be-model-vaccination-reduced.administeredProduct
  path:
    v: be-model-vaccination-reduced.administeredProduct
  short:
    v: The details of the product that was administered.
  definition:
    v: The details of the product that was administered
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: BackboneElement
      l: BackboneElement
element:
  id:
    v: be-model-vaccination-reduced.administeredProduct.product
  path:
    v: be-model-vaccination-reduced.administeredProduct.product
  short:
    v: The code of the product that was administered.
  definition:
    v: 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).
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Coding
      l: Coding
element:
  id:
    v: be-model-vaccination-reduced.administeredProduct.description
  path:
    v: be-model-vaccination-reduced.administeredProduct.description
  short:
    v: The description of the product that was administered.
  definition:
    v: The description of the product that was administered.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: be-model-vaccination-reduced.administeredProduct.lotNumber
  path:
    v: be-model-vaccination-reduced.administeredProduct.lotNumber
  short:
    v: The lot number
  definition:
    v: The lot number
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: be-model-vaccination-reduced.identifier
  path:
    v: be-model-vaccination-reduced.identifier
  short:
    v: The business identifier(s) for the vaccination entry
  definition:
    v: 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.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Identifier
      l: Identifier
element:
  id:
    v: be-model-vaccination-reduced.vaccinationDate[x]
  path:
    v: be-model-vaccination-reduced.vaccinationDate[x]
  short:
    v: The date and time when the vaccination has been administered
  definition:
    v: The date and/or time when the vaccine administration has been administered or presumed to be administered
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
  type:
    code:
      v: string
      l: string
element:
  id:
    v: be-model-vaccination-reduced.recorded
  path:
    v: be-model-vaccination-reduced.recorded
  short:
    v: The date and time when the administration of the vaccine was recorded
  definition:
    v: The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
element:
  id:
    v: be-model-vaccination-reduced.doseQuantity
  path:
    v: be-model-vaccination-reduced.doseQuantity
  short:
    v: The number or quantity of product(s) that was administered - e.g. 1/2 dose
  definition:
    v: The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: BackboneElement
      l: BackboneElement
element:
  id:
    v: be-model-vaccination-reduced.targetDisease
  path:
    v: be-model-vaccination-reduced.targetDisease
  short:
    v: The target disease for this vaccination.
  definition:
    v: The target disease for this vaccination.
  min:
    v: 1
  max:
    v: 1

code:
  v: CodeableConcept
  l: CodeableConcept

id:
  v: be-model-vaccination-reduced.sideEffects
path:
  v: be-model-vaccination-reduced.sideEffects
short:
  v: Any noted side effect from this vaccination.
definition:
  v: Any noted side effect from this vaccination.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Attachment
    l: Attachment

id:
  v: be-model-vaccination-reduced.cause
path:
  v: be-model-vaccination-reduced.cause
short:
  v: Is the vaccination due to pre or post exposition prophylaxis?
definition:
  v: Is the vaccination due to pre or post exposition prophylaxis?
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept