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

This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.3: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BeVaccination

Official URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination Version: 1.0.3
Active as of 2023-06-26 Maturity Level: 1 Computable Name: BeVaccination

Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationImmunization event information
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: The encounter should have a location from be-vs-care-location
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
... administeredProduct 0..1(Complex)BeAdministeredProduct
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
... recorder 1..1Reference(Patient core BE profile | Practitioner core BE profile | Organisation core BE profile)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... note 0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeThe status of this vaccination record entry
... statusReason S0..1CodeableConceptReason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode S1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
... patient S1..1Reference(Patient core BE profile)The patient that this received vaccination entry refers to
... encounter S0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] 1..1dateTime, stringVaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString S0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... location 0..0
... lotNumber 0..0
... expirationDate 0..0
... site S0..1CodeableConceptBody site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... bodyLaterality 0..1CodingBeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S0..1CodeableConceptHow vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... performer S0..*BackboneElementWho performed event
.... actor 1..1Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)Individual or organization who was performing
... reasonCode S0..*CodeableConceptCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... reaction S0..*BackboneElementReaction immediately after vaccination (15-30 minutes)
.... date 1..1dateTimeWhen reaction started
... protocolApplied S0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCoderequiredBeVSVaccineCode
Immunization.siterequiredBeVSVaccinationBodySite
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.reasonCodepreferredBeVSVaccinationReasonCode

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf vaccineCode.code is other, then vaccinecode text must exist
: vaccineCode.coding.code = 'other' implies vaccineCode.text.exists()
be-rule-vaccination-2errorImmunizationThe product code SHALL be cnk, cti extended or atc
: (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').value as CodeableConcept).exists().not() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').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').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').value as CodeableConcept).coding.where(system = 'http://whocc.no/atc').exists()
be-rule-vaccination-3errorImmunizationThe 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-4errorImmunizationThe encounter should have a location from be-vs-care-location
: encounter.empty() or encounter.resolve().location.location.resolve().type.coding.memberOf('https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-care-location').anyTrue()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationImmunization event information
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: The encounter should have a location from be-vs-care-location
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
... vaccination-confirmationStatus 0..1codeBeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
... recorder 1..1Reference(Patient core BE profile | Practitioner core BE profile | Organisation core BE profile)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... note 0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
... status ?!SΣ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
... patient SΣ1..1Reference(Patient core BE profile)The patient that this received vaccination entry refers to
... encounter S0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣ0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣ0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... site S0..1CodeableConceptBody site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... bodyLaterality 0..1CodingBeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S0..1CodeableConceptHow vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor Σ1..1Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)Individual or organization who was performing
... reasonCode S0..*CodeableConceptCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ0..1booleanDose potency
... reaction S0..*BackboneElementReaction immediately after vaccination (15-30 minutes)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateTimeWhen reaction started

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.identifier.userequiredIdentifierUse
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCoderequiredBeVSVaccineCode
Immunization.siterequiredBeVSVaccinationBodySite
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.reasonCodepreferredBeVSVaccinationReasonCode

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf vaccineCode.code is other, then vaccinecode text must exist
: vaccineCode.coding.code = 'other' implies vaccineCode.text.exists()
be-rule-vaccination-2errorImmunizationThe product code SHALL be cnk, cti extended or atc
: (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').value as CodeableConcept).exists().not() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').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').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').value as CodeableConcept).coding.where(system = 'http://whocc.no/atc').exists()
be-rule-vaccination-3errorImmunizationThe 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-4errorImmunizationThe encounter should have a location from be-vs-care-location
: encounter.empty() or encounter.resolve().location.location.resolve().type.coding.memberOf('https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-care-location').anyTrue()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationImmunization event information
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: The encounter should have a location from be-vs-care-location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
... administeredProduct 0..1(Complex)BeAdministeredProduct
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
... vaccination-confirmationStatus 0..1codeBeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
... recorder 1..1Reference(Patient core BE profile | Practitioner core BE profile | Organisation core BE profile)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... note 0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
... patient SΣ1..1Reference(Patient core BE profile)The patient that this received vaccination entry refers to
... encounter S0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣ0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣ0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... site S0..1CodeableConceptBody site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... bodyLaterality 0..1CodingBeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... route S0..1CodeableConceptHow vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction S0..*BackboneElementReaction immediately after vaccination (15-30 minutes)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.identifier.userequiredIdentifierUse
Immunization.identifier.typeextensibleIdentifier Type Codes
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCoderequiredBeVSVaccineCode
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siterequiredBeVSVaccinationBodySite
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationImmunization event information
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: The encounter should have a location from be-vs-care-location
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
... administeredProduct 0..1(Complex)BeAdministeredProduct
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
... recorder 1..1Reference(Patient core BE profile | Practitioner core BE profile | Organisation core BE profile)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... note 0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeThe status of this vaccination record entry
... statusReason S0..1CodeableConceptReason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode S1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
... patient S1..1Reference(Patient core BE profile)The patient that this received vaccination entry refers to
... encounter S0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] 1..1dateTime, stringVaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString S0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... location 0..0
... lotNumber 0..0
... expirationDate 0..0
... site S0..1CodeableConceptBody site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... bodyLaterality 0..1CodingBeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S0..1CodeableConceptHow vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... performer S0..*BackboneElementWho performed event
.... actor 1..1Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)Individual or organization who was performing
... reasonCode S0..*CodeableConceptCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... reaction S0..*BackboneElementReaction immediately after vaccination (15-30 minutes)
.... date 1..1dateTimeWhen reaction started
... protocolApplied S0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCoderequiredBeVSVaccineCode
Immunization.siterequiredBeVSVaccinationBodySite
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.reasonCodepreferredBeVSVaccinationReasonCode

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf vaccineCode.code is other, then vaccinecode text must exist
: vaccineCode.coding.code = 'other' implies vaccineCode.text.exists()
be-rule-vaccination-2errorImmunizationThe product code SHALL be cnk, cti extended or atc
: (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').value as CodeableConcept).exists().not() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').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').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').value as CodeableConcept).coding.where(system = 'http://whocc.no/atc').exists()
be-rule-vaccination-3errorImmunizationThe 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-4errorImmunizationThe encounter should have a location from be-vs-care-location
: encounter.empty() or encounter.resolve().location.location.resolve().type.coding.memberOf('https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-care-location').anyTrue()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationImmunization event information
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: The encounter should have a location from be-vs-care-location
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
... vaccination-confirmationStatus 0..1codeBeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
... recorder 1..1Reference(Patient core BE profile | Practitioner core BE profile | Organisation core BE profile)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... note 0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
... status ?!SΣ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
... patient SΣ1..1Reference(Patient core BE profile)The patient that this received vaccination entry refers to
... encounter S0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣ0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣ0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... site S0..1CodeableConceptBody site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... bodyLaterality 0..1CodingBeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S0..1CodeableConceptHow vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor Σ1..1Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)Individual or organization who was performing
... reasonCode S0..*CodeableConceptCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ0..1booleanDose potency
... reaction S0..*BackboneElementReaction immediately after vaccination (15-30 minutes)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateTimeWhen reaction started

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.identifier.userequiredIdentifierUse
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCoderequiredBeVSVaccineCode
Immunization.siterequiredBeVSVaccinationBodySite
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.reasonCodepreferredBeVSVaccinationReasonCode

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf vaccineCode.code is other, then vaccinecode text must exist
: vaccineCode.coding.code = 'other' implies vaccineCode.text.exists()
be-rule-vaccination-2errorImmunizationThe product code SHALL be cnk, cti extended or atc
: (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').value as CodeableConcept).exists().not() or (extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').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').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').value as CodeableConcept).coding.where(system = 'http://whocc.no/atc').exists()
be-rule-vaccination-3errorImmunizationThe 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-4errorImmunizationThe encounter should have a location from be-vs-care-location
: encounter.empty() or encounter.resolve().location.location.resolve().type.coding.memberOf('https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-care-location').anyTrue()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*ImmunizationImmunization event information
be-rule-vaccination-1: If vaccineCode.code is other, then vaccinecode text must exist
be-rule-vaccination-2: The product code SHALL be cnk, cti extended or atc
be-rule-vaccination-3: The reaction detail code SHALL come from be-vs-reaction-manifestation
be-rule-vaccination-4: The encounter should have a location from be-vs-care-location
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccination-originalorder 0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)BeVaccinationOriginalOrder
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
... administeredProduct 0..1(Complex)BeAdministeredProduct
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
... vaccination-confirmationStatus 0..1codeBeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
... recorder 1..1Reference(Patient core BE profile | Practitioner core BE profile | Organisation core BE profile)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
... note 0..1AnnotationBeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierA unique business identifier for a vaccination entry
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣ1..1codeThe status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S0..1CodeableConceptReason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
Binding: BeVSVaccineCode (required)
... patient SΣ1..1Reference(Patient core BE profile)The patient that this received vaccination entry refers to
... encounter S0..1Reference(Encounter)Encounter immunization was part of
... Slices for occurrence[x] Σ1..1Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣ0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣ0..1stringVaccine administration date
... recorded S1..1dateTimeThe date/time when the vaccination event has been recorded
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... site S0..1CodeableConceptBody site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... bodyLaterality 0..1CodingBeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
... route S0..1CodeableConceptHow vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ1..1Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode S0..*CodeableConceptCan be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction S0..*BackboneElementReaction immediately after vaccination (15-30 minutes)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 1..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.identifier.userequiredIdentifierUse
Immunization.identifier.typeextensibleIdentifier Type Codes
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
Immunization.vaccineCoderequiredBeVSVaccineCode
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siterequiredBeVSVaccinationBodySite
Immunization.routerequiredBeVSVaccineAdministrationRoute
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

 

Other representations of profile: CSV, Excel, Schematron