HL7 Belgium Vaccination (Patient Dossier)
1.0.0 - STU
This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.0: Trial Use) based on FHIR R4. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
Official URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination | Version: 1.0.0 | |||
Active as of 2022-05-31 | Maturity Level: 1 | Responsible: eHealth Platform | Realm: BE | Computable Name: BeVaccination |
Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Summary
Mandatory: 3 elements (3 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | I | 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 | ||||
id | Σ | 0..1 | string | 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.
| |||||
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 | |||||
be-ext-vaccination-originalorder | 0..1 | Reference(ImmunizationRecommendation | MedicationRequest | CarePlan) | BeVaccinationOriginalOrder URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder | |||||
be-ext-administeredProduct | 0..1 | (Complex) | BeAdministeredProduct URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct | |||||
be-ext-vaccination-confirmationStatus | 0..1 | code | BeVaccinationConfirmationStatus URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus Binding: BeVSVaccinationConfirmationStatus (required) | |||||
be-ext-recorder | 1..1 | Reference(BePatient | BePractitioner | BeOrganization) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder | |||||
be-ext-simple-note | 0..1 | Annotation | BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note | |||||
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) | 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 | |||||
be-ext-laterality | 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..* | 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 | BeOrganization | BePractitionerRole) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
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 | I | 0..* | BackboneElement | Educational material presented to patient | ||||
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 | |||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | I | 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 |
identifier | 0..* | Identifier | A unique business identifier for a vaccination entry | |
system | Σ | 1..1 | uri | The namespace for the identifier value |
value | Σ | 1..1 | string | The value that is unique |
status | ?!Σ | 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 | 0..1 | CodeableConcept | Reason not done Binding: BeVSVaccinationStatusReason (required) | |
vaccineCode | Σ | 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 | Σ | 1..1 | Reference(BePatient) | The patient that this received vaccination entry refers to |
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |
occurrence[x]:occurrenceDateTime | Σ | 0..1 | dateTime | Vaccine administration date |
occurrence[x]:occurrenceString | Σ | 0..1 | string | Vaccine administration date |
recorded | 1..1 | dateTime | The date/time when the vaccination event has been recorded | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: BeVSVaccinationBodySite (required) | |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: BeVSVaccineAdministrationRoute (required) | |
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |
performer | Σ | 0..* | BackboneElement | Who performed event |
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why vaccination has occurred or not (reference to a finding) | |
reaction | 0..* | BackboneElement | Reaction immediately after vaccination (15-30 minutes) | |
Documentation for this format |
This structure is derived from Immunization
Summary
Mandatory: 3 elements (3 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from Immunization
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | I | 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 | ||||
id | Σ | 0..1 | string | 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.
| |||||
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 | |||||
be-ext-vaccination-originalorder | 0..1 | Reference(ImmunizationRecommendation | MedicationRequest | CarePlan) | BeVaccinationOriginalOrder URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder | |||||
be-ext-administeredProduct | 0..1 | (Complex) | BeAdministeredProduct URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct | |||||
be-ext-vaccination-confirmationStatus | 0..1 | code | BeVaccinationConfirmationStatus URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus Binding: BeVSVaccinationConfirmationStatus (required) | |||||
be-ext-recorder | 1..1 | Reference(BePatient | BePractitioner | BeOrganization) | Extension URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder | |||||
be-ext-simple-note | 0..1 | Annotation | BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note | |||||
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) | 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 | |||||
be-ext-laterality | 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..* | 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 | BeOrganization | BePractitionerRole) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
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 | I | 0..* | BackboneElement | Educational material presented to patient | ||||
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 | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Immunization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Immunization.identifier.use | required | IdentifierUse |
Immunization.identifier.type | extensible | Identifier Type Codes |
Immunization.status | required | ImmunizationStatusCodes |
Immunization.statusReason | required | BeVSVaccinationStatusReason |
Immunization.vaccineCode | required | BeVSVaccineCode |
Immunization.reportOrigin | example | ImmunizationOriginCodes |
Immunization.site | required | BeVSVaccinationBodySite |
Immunization.route | required | BeVSVaccineAdministrationRoute |
Immunization.performer.function | extensible | ImmunizationFunctionCodes |
Immunization.reasonCode | example | ImmunizationReasonCodes |
Immunization.subpotentReason | example | ImmunizationSubpotentReason |
Immunization.programEligibility | example | ImmunizationProgramEligibility |
Immunization.fundingSource | example | ImmunizationFundingSource |
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
Id | Grade | Path | Details | Requirements |
be-rule-vaccination-1 | error | Immunization | If vaccineCode.code is other, then vaccinecode text must exist : vaccineCode.coding.code = 'other' implies vaccineCode.text.exists() | |
be-rule-vaccination-2 | error | Immunization | The product code SHALL be cnk, cti extended or atc : extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').valueCodeableConcept.exists().not() or extension('https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct').extension('coded').valueCodeableConcept.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').valueCodeableConcept.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').valueCodeableConcept.coding.where(system = 'http://whocc.no/atc').exists() | |
be-rule-vaccination-3 | error | Immunization | The reaction detail code SHALL come from be-vs-reaction-manifestation : reaction.detail.empty() or reaction.detail.resolve().code.memberOf('https://www.ehealth.fgov.be/standards/fhir/core-clinical/ValueSet/be-vs-reaction-manifestation-code').anyTrue() |