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

HL7 Belgium Vaccination (Patient Dossier), published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/vaccination/ and changes regularly. See the Directory of published versions

Resource Profile: BeVaccination

Official URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination Version: 1.1.0
Active as of 2024-09-04 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 C 0..* Immunization Immunization 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: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccination-originalorder 0..1 Reference(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..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
.... recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
.... vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
.... vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
... identifier S 0..* Identifier A unique business identifier for a vaccination entry
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... status S 1..1 code The status of this vaccination record entry
... vaccineCode S 1..1 CodeableConcept The 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..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime Vaccine administration date
.... occurrence[x]:occurrenceString S 0..1 string Vaccine administration date
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
... location 0..0
... lotNumber 0..0
... expirationDate 0..0
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... Slices for extension Content/Rules for all slices
..... bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
... performer S 0..1 BackboneElement Who performed event
.... actor 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
.... date 1..1 dateTime When reaction started
... protocolApplied S 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf 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-2errorImmunizationThe 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-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-4errorImmunizationIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization 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: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccination-originalorder 0..1 Reference(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..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
.... recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
.... vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
.... vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

... statusReason S 0..1 CodeableConcept Reason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ 1..1 CodeableConcept The 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..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
.... occurrence[x]:occurrenceString SΣ 0..1 string Vaccine administration date
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... Slices for extension Content/Rules for all slices
..... bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 0..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 1..1 dateTime When reaction started

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf 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-2errorImmunizationThe 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-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-4errorImmunizationIf 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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization 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: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccination-originalorder 0..1 Reference(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..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
.... recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
.... vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
.... vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier A unique business identifier for a vaccination entry
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code The status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ 1..1 CodeableConcept The 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..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
.... occurrence[x]:occurrenceString SΣ 0..1 string Vaccine administration date
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates 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..1 Reference(Organization) Vaccine manufacturer
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 0..1 BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C 0..* BackboneElement Educational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


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

... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 1..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf 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-2errorImmunizationThe 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-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-4errorImmunizationIf 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()

This structure is derived from Immunization

Summary

Mandatory: 3 elements(3 nested mandatory elements)
Must-Support: 19 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]

Maturity: 1

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization 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: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccination-originalorder 0..1 Reference(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..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
.... recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
.... vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
.... vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
... identifier S 0..* Identifier A unique business identifier for a vaccination entry
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
... status S 1..1 code The status of this vaccination record entry
... vaccineCode S 1..1 CodeableConcept The 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..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] 1..1 dateTime, string Vaccine administration date
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime Vaccine administration date
.... occurrence[x]:occurrenceString S 0..1 string Vaccine administration date
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
... location 0..0
... lotNumber 0..0
... expirationDate 0..0
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... Slices for extension Content/Rules for all slices
..... bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
... performer S 0..1 BackboneElement Who performed event
.... actor 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
.... date 1..1 dateTime When reaction started
... protocolApplied S 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf 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-2errorImmunizationThe 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-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-4errorImmunizationIf 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization 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: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccination-originalorder 0..1 Reference(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..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
.... recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
.... vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
.... vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

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

... statusReason S 0..1 CodeableConcept Reason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ 1..1 CodeableConcept The 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..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
.... occurrence[x]:occurrenceString SΣ 0..1 string Vaccine administration date
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... Slices for extension Content/Rules for all slices
..... bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 0..1 BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 1..1 dateTime When reaction started

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf 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-2errorImmunizationThe 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-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-4errorImmunizationIf 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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Immunization 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: If the encounter has a location, and it has a type, its type should be from be-vs-care-location
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... vaccination-originalorder 0..1 Reference(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..1 code BeVaccinationConfirmationStatus
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: BeVSVaccinationConfirmationStatus (required)
.... recorder 1..1 Reference(BePatient(2.1.2) | BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) BeExtRecorder
URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
.... note 0..1 Annotation BeExtSimpleNote
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
.... vaccination-stock-location 0..1 Reference(Location) BeVaccinationStockOrigin
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-location
.... vaccination-stock-funding-organization 0..1 Reference(Organization) BeVaccinationStockFundingOrganization
URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-stock-funding-organization
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier A unique business identifier for a vaccination entry
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description 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..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code The status of this vaccination record entry
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason S 0..1 CodeableConcept Reason not done
Binding: BeVSVaccinationStatusReason (required)
... vaccineCode SΣ 1..1 CodeableConcept The 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..1 Reference(BePatient(2.1.2)) The patient that this received vaccination entry refers to
... encounter S 0..1 Reference(Encounter) Encounter immunization was part of
... Slices for occurrence[x] Σ 1..1 Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTime dateTime
.... occurrenceString string
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime Vaccine administration date
.... occurrence[x]:occurrenceString SΣ 0..1 string Vaccine administration date
... recorded S 1..1 dateTime The date/time when the vaccination event has been recorded
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates 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..1 Reference(Organization) Vaccine manufacturer
... site S 0..1 CodeableConcept Body site vaccine was administered
Binding: BeVSVaccinationBodySite (required)
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... bodyLaterality 0..1 Coding BeExtLaterality
URL: https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality
Binding: Laterality (required)
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 0..1 string Plain text representation of the concept
... route S 0..1 CodeableConcept How vaccine entered body
Binding: BeVSVaccineAdministrationRoute (required)
... doseQuantity S 0..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 0..1 BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor Σ 1..1 Reference(BePractitioner(2.1.2) | BeOrganization(2.1.2) | BePractitionerRole(2.1.2)) Individual or organization who was performing
... note Σ 0..* Annotation Additional immunization notes
... reasonCode S 0..* CodeableConcept Can be used to indicate whether vaccination/prophylaxis took place pre- or post-exposition
Binding: BeVSVaccinationReasonCode (preferred)
... reasonReference S 0..* Reference(Condition | Observation | DiagnosticReport) Why vaccination has occurred or not (reference to a finding)
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C 0..* BackboneElement Educational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


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

... reaction S 0..* BackboneElement Reaction immediately after vaccination (15-30 minutes)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 1..1 dateTime When reaction started
.... detail 0..1 Reference(Observation) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Immunization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Immunization.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
from the FHIR Standard
Immunization.statusReasonrequiredBeVSVaccinationStatusReason
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason
from this IG
Immunization.vaccineCoderequiredBeVSVaccineCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccine-code
from this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard
Immunization.siterequiredBeVSVaccinationBodySite
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-bodysite
from this IG
Immunization.routerequiredBeVSVaccineAdministrationRoute
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-administration-route
from this IG
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
from the FHIR Standard
Immunization.reasonCodepreferredBeVSVaccinationReasonCode
https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-reason-code
from this IG
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
from the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
from the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
from the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
be-rule-vaccination-1errorImmunizationIf 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-2errorImmunizationThe 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-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-4errorImmunizationIf 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()

This structure is derived from Immunization

Summary

Mandatory: 3 elements(3 nested mandatory elements)
Must-Support: 19 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.occurrence[x]

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron