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

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

Resource Profile: BeVaccination - Detailed Descriptions

Active as of 2024-09-04 Maturity Level: 1

Definitions for the be-vaccination resource profile.

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

0. Immunization
Invariantsbe-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist ((vaccineCode.coding.where(code = 'other').exists() or vaccineCode.coding.where(code = '787859002' and system = 'http://snomed.info/sct').exists() ) implies vaccineCode.text.exists())
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc ((extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).exists().not() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).coding.where(system = 'https://www.ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-cnk-codes').exists() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).coding.where(system = 'https://www.ehealth.fgov.be/standards/fhir/medication/NamingSystem/be-ns-cti-extended-code').exists() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').select($this.value as CodeableConcept)).coding.where(system = 'http://whocc.no/atc').exists())
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation (reaction.detail.empty() or reaction.detail.resolve().code.memberOf('https://www.ehealth.fgov.be/standards/fhir/core-clinical/ValueSet/be-vs-reaction-manifestation-code').anyTrue())
be-rule-vaccination-4: If the encounter has a location, and it has a type, its type should be from be-vs-care-location (encounter.empty() or encounter.resolve().location.empty() or encounter.resolve().location.location.resolve().type.empty() or encounter.resolve().location.location.resolve().type.coding.memberOf('https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-care-location').anyTrue())
2. Immunization.extension
Control1..?
SlicingThis element introduces a set of slices on Immunization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Immunization.extension:vaccination-originalorder
    Slice Namevaccination-originalorder
    Control0..1
    TypeExtension(BeVaccinationOriginalOrder) (Extension Type: Reference(ImmunizationRecommendation, MedicationRequest, CarePlan))
    6. Immunization.extension:administeredProduct
    Slice NameadministeredProduct
    Control0..1
    TypeExtension(BeAdministeredProduct) (Complex Extension)
    8. Immunization.extension:vaccination-confirmationStatus
    Slice Namevaccination-confirmationStatus
    Control0..1
    TypeExtension(BeVaccinationConfirmationStatus) (Extension Type: code)
    10. Immunization.extension:recorder
    Slice Namerecorder
    Control1..1
    TypeExtension(BeExtRecorder) (Extension Type: Choice of: CodeableConcept, Reference)
    12. Immunization.extension:note
    Slice Namenote
    Control0..1
    TypeExtension(BeExtSimpleNote) (Extension Type: Annotation)
    14. Immunization.extension:vaccination-stock-location
    Slice Namevaccination-stock-location
    Control0..1
    TypeExtension(BeVaccinationStockOrigin) (Extension Type: Reference(Location))
    16. Immunization.extension:vaccination-stock-funding-organization
    Slice Namevaccination-stock-funding-organization
    Control0..1
    TypeExtension(BeVaccinationStockFundingOrganization) (Extension Type: Reference(Organization))
    18. Immunization.identifier
    ShortA unique business identifier for a vaccination entry
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Must Supporttrue
    20. Immunization.identifier.system
    Control1..?
    Must Supporttrue
    22. Immunization.identifier.value
    Control1..?
    Must Supporttrue
    24. Immunization.status
    ShortThe status of this vaccination record entry
    Must Supporttrue
    26. Immunization.statusReason
    BindingThe codes SHALL be taken from BeVSVaccinationStatusReason
    (required to https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason)
    Must Supporttrue
    28. Immunization.vaccineCode
    ShortThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
    BindingThe codes SHALL be taken from BeVSVaccineCode
    (required to https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code)
    Must Supporttrue
    30. Immunization.patient
    ShortThe patient that this received vaccination entry refers to
    TypeReference(BePatient)
    Must Supporttrue
    32. Immunization.encounter
    Must Supporttrue
    34. Immunization.occurrence[x]
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    SlicingThis element introduces a set of slices on Immunization.occurrence[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 36. Immunization.occurrence[x]:occurrenceDateTime
      Slice NameoccurrenceDateTime
      Control0..1
      TypedateTime
      [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
      Must Supporttrue
      38. Immunization.occurrence[x]:occurrenceString
      Slice NameoccurrenceString
      Control0..1
      Typestring
      [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
      Must Supporttrue
      40. Immunization.recorded
      ShortThe date/time when the vaccination event has been recorded
      Control1..?
      Must Supporttrue
      42. Immunization.location
      Control0..0
      44. Immunization.lotNumber
      Control0..0
      46. Immunization.expirationDate
      Control0..0
      48. Immunization.site
      BindingThe codes SHALL be taken from BeVSVaccinationBodySite
      (required to https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite)
      Must Supporttrue
      50. Immunization.site.extension:bodyLaterality
      Slice NamebodyLaterality
      Control0..1
      TypeExtension(BeExtLaterality) (Extension Type: Coding)
      52. Immunization.route
      BindingThe codes SHALL be taken from BeVSVaccineAdministrationRoute
      (required to https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route)
      Must Supporttrue
      54. Immunization.doseQuantity
      Must Supporttrue
      56. Immunization.performer
      Control0..1
      Must Supporttrue
      58. Immunization.performer.actor
      TypeReference(BePractitioner, BeOrganization, BePractitionerRole)
      60. Immunization.reasonCode
      ShortCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
      BindingThe codes SHOULD be taken from BeVSVaccinationReasonCode
      (preferred to https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code)
      Must Supporttrue
      62. Immunization.reasonReference
      ShortWhy vaccination has occurred or not (reference to a finding)
      Must Supporttrue
      64. Immunization.reaction
      ShortReaction immediately after vaccination (15-30 minutes)
      Must Supporttrue
      66. Immunization.reaction.date
      Control1..?
      68. Immunization.protocolApplied
      Control0..0
      Must Supporttrue