be-model-vaccination
type: StructureDefinition
node role: treeRoot
id:
  v: be-model-vaccination
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition be-model-vaccination Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> be-model-vaccination 0..* Element BeModelVaccination 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; recorded 1..1 dateTime The date and time when the administration of the vaccine was recorded #xD; patient 1..1 Reference(Patient) The patient that received vaccination. #xD; vaccinationRequest 0..1 Reference() The patient-specific order or recommendation for the vaccination #xD; recorder 1..1 Reference(Practitioner) The professional that recorded the administration of the vaccine #xD; performer 0..1 Reference(Practitioner) The professional that administered the medication #xD; vaccineCode 1..1 CodeableConcept The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa #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; administeredProduct 0..1 BackboneElement The details of the product that was administered…
url:
  v: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination
  l: be-model-vaccination
version:
  v: 1.1.2
name:
  v: BeModelVaccination
status:
  v: active
date:
  v: 2025-11-27T08:50:18+00: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: 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: map-be-model-vaccination-to-be-vaccination
  uri:
    v: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination
    l: be-vaccination
  name:
    v: BeModelVaccinationToBVaccination
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
  l: be-model-vaccination
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
    path:
      v: be-model-vaccination
    short:
      v: BeModelVaccination
    definition:
      v: BeModelVaccination
    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: map-be-model-vaccination-to-be-vaccination
      map:
        v: BeVaccination
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: be-model-vaccination.id
    path:
      v: be-model-vaccination.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.extension
    path:
      v: be-model-vaccination.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

Url
v: string
l: string

v: value

v: url

v: *

code:
  v: Extension
  l: Extension

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

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.recorded
path:
  v: be-model-vaccination.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.recorded
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: recorded

id:
  v: be-model-vaccination.patient
path:
  v: be-model-vaccination.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.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: patient

id:
  v: be-model-vaccination.vaccinationRequest
path:
  v: be-model-vaccination.vaccinationRequest
short:
  v: The patient-specific order or recommendation for the vaccination
definition:
  v: The patient-specific order or recommendation for the vaccination, for example a prescription or a request for vaccination for a patient by a physician, for example for optional vaccines.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.vaccinationRequest
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-vaccination-originalorder

id:
  v: be-model-vaccination.recorder
path:
  v: be-model-vaccination.recorder
short:
  v: The professional that recorded the administration of the vaccine
definition:
  v: The professional that recorded the administration of the vaccine.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination.recorder
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-recorder

id:
  v: be-model-vaccination.performer
path:
  v: be-model-vaccination.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: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.performer
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    l: Practitioner
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: performer

id:
  v: be-model-vaccination.vaccineCode
path:
  v: be-model-vaccination.vaccineCode
short:
  v: The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
definition:
  v: The vaccine code - a type of vaccine, typically identified by the disease(s) it covers. For example MMR, HPV, Tetanus, DTPa. This should be a coded value.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination.vaccineCode
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: vaccineCode

id:
  v: be-model-vaccination.vaccinationDate[x]
path:
  v: be-model-vaccination.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.vaccinationDate[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: occurrence

id:
  v: be-model-vaccination.administeredProduct
path:
  v: be-model-vaccination.administeredProduct
short:
  v: The details of the product that was administered.
definition:
  v: The details of the product that was administered
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.administeredProduct
  min:
    v: 0
  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
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct

id:
  v: be-model-vaccination.administeredProduct.id
path:
  v: be-model-vaccination.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.administeredProduct.extension
path:
  v: be-model-vaccination.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.administeredProduct.modifierExtension
path:
  v: be-model-vaccination.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.administeredProduct.product[x]
path:
  v: be-model-vaccination.administeredProduct.product[x]
short:
  v: The actual product that was administered. This should be a product code or a reference to an actual Medication resource
definition:
  v: The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)
comment:
  v: In the case where the product is not known, use code "unknown"
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.administeredProduct.product[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct.code

id:
  v: be-model-vaccination.administeredProduct.lotNumber
path:
  v: be-model-vaccination.administeredProduct.lotNumber
short:
  v: The lot number
definition:
  v: The lot number
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.administeredProduct.lotNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct.batch.lotNumber

id:
  v: be-model-vaccination.administeredProduct.expirationDate
path:
  v: be-model-vaccination.administeredProduct.expirationDate
short:
  v: The expiration date of the product.
definition:
  v: The expiration date of the product.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.administeredProduct.expirationDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: date
    l: date
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct.batch.expirationDate

id:
  v: be-model-vaccination.route
path:
  v: be-model-vaccination.route
short:
  v: The route of administration.
definition:
  v: The route of administration for the vaccine. This can be free text (not desired) or a code
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.route
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: route

id:
  v: be-model-vaccination.status
path:
  v: be-model-vaccination.status
short:
  v: The status of this vaccination record entry
definition:
  v: The status of the vaccination record entry - whether it is active, entered in error, etc.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: status

id:
  v: be-model-vaccination.statusReason
path:
  v: be-model-vaccination.statusReason
short:
  v: The reason for the status e.g. 'not completed because...'
definition:
  v: Supporting reason for status information.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.statusReason
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: required
  description:
    v: Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine
  value set:
    v: https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
    l: be-vs-vaccination-status-reason
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: statusReason

id:
  v: be-model-vaccination.reaction
path:
  v: be-model-vaccination.reaction
short:
  v: Reaction to the immunization - cfr. AllergyIntolerance
definition:
  v: Reaction to the immunization - cfr. AllergyIntolerance
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.reaction
  min:
    v: 0
  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
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: reaction

id:
  v: be-model-vaccination.reaction.id
path:
  v: be-model-vaccination.reaction.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.reaction.extension
path:
  v: be-model-vaccination.reaction.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.reaction.modifierExtension
path:
  v: be-model-vaccination.reaction.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.reaction.reactionDate
path:
  v: be-model-vaccination.reaction.reactionDate
short:
  v: date of the reaction
definition:
  v: date of the reaction
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination.reaction.reactionDate
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: reaction.date

id:
  v: be-model-vaccination.reaction.manifestation
path:
  v: be-model-vaccination.reaction.manifestation
short:
  v: reference to the observation of the reaction
definition:
  v: reference to the observation of the reaction
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.reaction.manifestation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: reaction.detail

id:
  v: be-model-vaccination.doseQuantity
path:
  v: be-model-vaccination.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.doseQuantity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: doseQuantity

id:
  v: be-model-vaccination.note
path:
  v: be-model-vaccination.note
short:
  v: Additional notes for the vaccination.
definition:
  v: Additional notes for the vaccination
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.note
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Attachment
    l: Attachment
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: note

id:
  v: be-model-vaccination.site
path:
  v: be-model-vaccination.site
short:
  v: The body site where the vaccination entered the body
definition:
  v: The body site where the vaccination entered the body
min:
  v: 1
max:
  v: 1
base:
  path:
    v: be-model-vaccination.site
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: site

id:
  v: be-model-vaccination.identifier
path:
  v: be-model-vaccination.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: *
base:
  path:
    v: be-model-vaccination.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: identifier

id:
  v: be-model-vaccination.bodyLaterality
path:
  v: be-model-vaccination.bodyLaterality
short:
  v: The side of the body (for sites that occur on both sides of the body)
definition:
  v: The side of the body (for sites that occur on both sides of the body)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.bodyLaterality
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: be-model-vaccination.location
path:
  v: be-model-vaccination.location
short:
  v: The location where the immunization is performed.
definition:
  v: a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai'
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.location
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-vaccination-location

id:
  v: be-model-vaccination.locationType
path:
  v: be-model-vaccination.locationType
short:
  v: The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
definition:
  v: The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.locationType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: be-model-vaccination.cause
path:
  v: be-model-vaccination.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.cause
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: be-model-vaccination.stockOrigin
path:
  v: be-model-vaccination.stockOrigin
short:
  v: The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
definition:
  v: The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.stockOrigin
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Location
    l: Location

id:
  v: be-model-vaccination.stockFundingEntity
path:
  v: be-model-vaccination.stockFundingEntity
short:
  v: The entity that is funding the provision of the vaccines
definition:
  v: The entity that is funding the provision of the vaccines
min:
  v: 0
max:
  v: 1
base:
  path:
    v: be-model-vaccination.stockFundingEntity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization

element:
  id:
    v: be-model-vaccination
  path:
    v: be-model-vaccination
  short:
    v: BeModelVaccination
  definition:
    v: BeModelVaccination
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: BeVaccination
element:
  id:
    v: be-model-vaccination.recorded
  path:
    v: be-model-vaccination.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
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: recorded
element:
  id:
    v: be-model-vaccination.patient
  path:
    v: be-model-vaccination.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
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: patient
element:
  id:
    v: be-model-vaccination.vaccinationRequest
  path:
    v: be-model-vaccination.vaccinationRequest
  short:
    v: The patient-specific order or recommendation for the vaccination
  definition:
    v: The patient-specific order or recommendation for the vaccination, for example a prescription or a request for vaccination for a patient by a physician, for example for optional vaccines.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: extension.be-ext-vaccination-originalorder
element:
  id:
    v: be-model-vaccination.recorder
  path:
    v: be-model-vaccination.recorder
  short:
    v: The professional that recorded the administration of the vaccine
  definition:
    v: The professional that recorded the administration of the vaccine.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Practitioner
      l: Practitioner
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: extension.be-ext-recorder
element:
  id:
    v: be-model-vaccination.performer
  path:
    v: be-model-vaccination.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: 0
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Practitioner
      l: Practitioner
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: performer
element:
  id:
    v: be-model-vaccination.vaccineCode
  path:
    v: be-model-vaccination.vaccineCode
  short:
    v: The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
  definition:
    v: The vaccine code - a type of vaccine, typically identified by the disease(s) it covers. For example MMR, HPV, Tetanus, DTPa. This should be a coded value.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: CodeableConcept
      l: CodeableConcept
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: vaccineCode
element:
  id:
    v: be-model-vaccination.vaccinationDate[x]
  path:
    v: be-model-vaccination.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
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: occurrence
element:
  id:
    v: be-model-vaccination.administeredProduct
  path:
    v: be-model-vaccination.administeredProduct
  short:
    v: The details of the product that was administered.
  definition:
    v: The details of the product that was administered
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: BackboneElement
      l: BackboneElement
  mapping:
    identity:
      v: map-be-model-vaccination-to-be-vaccination
    map:
      v: extension.be-ext-administeredProduct

id:
  v: be-model-vaccination.administeredProduct.product[x]
path:
  v: be-model-vaccination.administeredProduct.product[x]
short:
  v: The actual product that was administered. This should be a product code or a reference to an actual Medication resource
definition:
  v: The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)
comment:
  v: In the case where the product is not known, use code "unknown"
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct.code

id:
  v: be-model-vaccination.administeredProduct.lotNumber
path:
  v: be-model-vaccination.administeredProduct.lotNumber
short:
  v: The lot number
definition:
  v: The lot number
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct.batch.lotNumber

id:
  v: be-model-vaccination.administeredProduct.expirationDate
path:
  v: be-model-vaccination.administeredProduct.expirationDate
short:
  v: The expiration date of the product.
definition:
  v: The expiration date of the product.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: date
    l: date
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-administeredProduct.batch.expirationDate

id:
  v: be-model-vaccination.route
path:
  v: be-model-vaccination.route
short:
  v: The route of administration.
definition:
  v: The route of administration for the vaccine. This can be free text (not desired) or a code
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: route

id:
  v: be-model-vaccination.status
path:
  v: be-model-vaccination.status
short:
  v: The status of this vaccination record entry
definition:
  v: The status of the vaccination record entry - whether it is active, entered in error, etc.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: code
    l: code
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: status

id:
  v: be-model-vaccination.statusReason
path:
  v: be-model-vaccination.statusReason
short:
  v: The reason for the status e.g. 'not completed because...'
definition:
  v: Supporting reason for status information.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: required
  description:
    v: Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine
  value set:
    v: https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
    l: be-vs-vaccination-status-reason
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: statusReason

id:
  v: be-model-vaccination.reaction
path:
  v: be-model-vaccination.reaction
short:
  v: Reaction to the immunization - cfr. AllergyIntolerance
definition:
  v: Reaction to the immunization - cfr. AllergyIntolerance
min:
  v: 0
max:
  v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: reaction

id:
  v: be-model-vaccination.reaction.reactionDate
path:
  v: be-model-vaccination.reaction.reactionDate
short:
  v: date of the reaction
definition:
  v: date of the reaction
min:
  v: 1
max:
  v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: reaction.date

id:
  v: be-model-vaccination.reaction.manifestation
path:
  v: be-model-vaccination.reaction.manifestation
short:
  v: reference to the observation of the reaction
definition:
  v: reference to the observation of the reaction
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: reaction.detail

id:
  v: be-model-vaccination.doseQuantity
path:
  v: be-model-vaccination.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
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: doseQuantity

id:
  v: be-model-vaccination.note
path:
  v: be-model-vaccination.note
short:
  v: Additional notes for the vaccination.
definition:
  v: Additional notes for the vaccination
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Attachment
    l: Attachment
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: note

id:
  v: be-model-vaccination.site
path:
  v: be-model-vaccination.site
short:
  v: The body site where the vaccination entered the body
definition:
  v: The body site where the vaccination entered the body
min:
  v: 1
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: site

id:
  v: be-model-vaccination.identifier
path:
  v: be-model-vaccination.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: *
type:
  code:
    v: Identifier
    l: Identifier
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: identifier

id:
  v: be-model-vaccination.bodyLaterality
path:
  v: be-model-vaccination.bodyLaterality
short:
  v: The side of the body (for sites that occur on both sides of the body)
definition:
  v: The side of the body (for sites that occur on both sides of the body)
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: be-model-vaccination.location
path:
  v: be-model-vaccination.location
short:
  v: The location where the immunization is performed.
definition:
  v: a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai'
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
mapping:
  identity:
    v: map-be-model-vaccination-to-be-vaccination
  map:
    v: extension.be-ext-vaccination-location

id:
  v: be-model-vaccination.locationType
path:
  v: be-model-vaccination.locationType
short:
  v: The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
definition:
  v: The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: be-model-vaccination.cause
path:
  v: be-model-vaccination.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

id:
  v: be-model-vaccination.stockOrigin
path:
  v: be-model-vaccination.stockOrigin
short:
  v: The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
definition:
  v: The stock position where the product is originating from. This can be a specific location like a shelf, a warehouse, a building...
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Location
    l: Location

id:
  v: be-model-vaccination.stockFundingEntity
path:
  v: be-model-vaccination.stockFundingEntity
short:
  v: The entity that is funding the provision of the vaccines
definition:
  v: The entity that is funding the provision of the vaccines
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization