This page is part of the HL7 Belgium FHIR Implementation Guide - Vaccination profiles (v1.0.1: 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: BeVaccination

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

Usage:

• Examples for this Resource Profile: Immunization/aymeric-rota1, Immunization/aymeric-rota2, Immunization/aymeric-rota3, Immunization/covid-jan-1, Immunization/covid-jan-2-discarded, Immunization/covid-jan-3, Immunization/eva-hpv1-school, Immunization/eva-hpv2-school, Immunization/gabriel-flu, Immunization/iex1, Immunization/iex2, Immunization/iex3, Immunization/immunization-example-1-hpv, Immunization/immunization-example-childhood-measles, Immunization/immunization-example-mistaken-entry-update, Immunization/immunization-example-mistaken-entry, Immunization/immunization-example-not-given-contraindication, Immunization/immunization-example-not-given-refusal, Immunization/immunization-example-not-given-stock, Immunization/immunization-example-prescribed-vaccination, Immunization/immunization-example-reaction-swelling, Immunization/immunization-example-tetanus-cautious-reinforcement, Immunization/juan-hexa1-reported, Immunization/juan-hexa2-reported-hospital, Immunization/juan-hexa3-skipped, Immunization/juan-hexa4, Immunization/julia-refuse-hpv, Immunization/othercode, Immunization/simon-hpv-at-work, Immunization/toto-hexa1, Immunization/toto-hexa2, Immunization/toto-hexa3, Immunization/toto-hexa4-skipped, Immunization/toto-hexa4-swelling

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
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
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(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..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
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
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(Patient core BE profile)	The patient that this received vaccination entry refers to
encounter	S	0..1	Reference(Encounter)	Encounter immunization was part of
occurrenceDateTime	S	0..1	dateTime	Vaccine administration date
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)
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..*	BackboneElement	Who performed event
actor		1..1	Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)	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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Immunization.statusReason	required	BeVSVaccinationStatusReason
Immunization.vaccineCode	required	BeVSVaccineCode
Immunization.site	required	BeVSVaccinationBodySite
Immunization.route	required	BeVSVaccineAdministrationRoute
Immunization.reasonCode	preferred	BeVSVaccinationReasonCode

Constraints

Id	Grade	Path(s)	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()

Name	Flags	Card.	Type	Description & Constraints
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
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(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..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
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(Patient core BE profile)	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)
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..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	1..1	Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.identifier.use	required	IdentifierUse
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	required	BeVSVaccinationStatusReason
Immunization.vaccineCode	required	BeVSVaccineCode
Immunization.site	required	BeVSVaccinationBodySite
Immunization.route	required	BeVSVaccineAdministrationRoute
Immunization.reasonCode	preferred	BeVSVaccinationReasonCode

Constraints

Id	Grade	Path(s)	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()

Name	Flags	Card.	Type	Description & Constraints
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
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 Bindings Purpose 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(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..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(Patient core BE profile)	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..*	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(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)	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
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

Terminology Bindings

Path	Conformance	ValueSet
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
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	preferred	BeVSVaccinationReasonCode
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes

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:

• Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• Practitioner core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• Organisation core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
• Practitioner role core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
• https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality

Maturity: 1

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
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
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(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..1	Annotation	BeExtSimpleNote URL: https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
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
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(Patient core BE profile)	The patient that this received vaccination entry refers to
encounter	S	0..1	Reference(Encounter)	Encounter immunization was part of
occurrenceDateTime	S	0..1	dateTime	Vaccine administration date
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)
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..*	BackboneElement	Who performed event
actor		1..1	Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)	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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Immunization.statusReason	required	BeVSVaccinationStatusReason
Immunization.vaccineCode	required	BeVSVaccineCode
Immunization.site	required	BeVSVaccinationBodySite
Immunization.route	required	BeVSVaccineAdministrationRoute
Immunization.reasonCode	preferred	BeVSVaccinationReasonCode

Constraints

Id	Grade	Path(s)	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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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
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(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..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
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(Patient core BE profile)	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)
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..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	Σ	1..1	Reference(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)	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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.identifier.use	required	IdentifierUse
Immunization.status	required	ImmunizationStatusCodes
Immunization.statusReason	required	BeVSVaccinationStatusReason
Immunization.vaccineCode	required	BeVSVaccineCode
Immunization.site	required	BeVSVaccinationBodySite
Immunization.route	required	BeVSVaccineAdministrationRoute
Immunization.reasonCode	preferred	BeVSVaccinationReasonCode

Constraints

Id	Grade	Path(s)	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
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 Bindings Purpose 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(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..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(Patient core BE profile)	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..*	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(Practitioner core BE profile | Organisation core BE profile | Practitioner role core BE profile)	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
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

Terminology Bindings

Path	Conformance	ValueSet
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
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	preferred	BeVSVaccinationReasonCode
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes

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:

• Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• Practitioner core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitioner)
• Organisation core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization)
• Practitioner role core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-practitionerrole)

Extensions

This structure refers to these extensions:

• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-originalorder
• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-administeredProduct
• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-vaccination-confirmationStatus
• https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-ext-recorder
• https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-ext-simple-note
• https://www.ehealth.fgov.be/standards/fhir/core-clinical/StructureDefinition/be-ext-laterality

Maturity: 1

Other representations of profile: CSV, Excel, Schematron