HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BEImmunization

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

The official URL for this profile is: 

https://www.hl7belgium.org/standards/fhir/StructureDefinition/be-immunization

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 0..*ImmunizationImmunization event information
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... basedOn 0..1Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/basedOn
... administeredProduct 0..1CodeableConcept, Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/administeredProduct
... identifier S1..*IdentifierThe clinical status of the immunization - whether it is active, resolved...
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeThe status of this immunization record entry
... statusReason S0..1CodeableConceptReason not done
... vaccineCode S1..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
... patient 1..1Reference(Patient)The patient that this received immunization entry refers to
... occurrenceDateTime S0..1dateTimeVaccine administration date
... occurrenceString S0..1stringVaccine administration date
... recorded S0..1dateTimeThe date/time when the immunization event has been recorded
... location S0..1Reference(Location)Where immunization occurred
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
... route S0..1CodeableConceptHow vaccine entered body
... performer S0..*BackboneElementWho performed event
.... actor 1..1Reference(Practitioner | Organization | PractitionerRole)Individual or organization who was performing
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... doseNumberString 0..1stringWhether this is a first immunization or a reinforcement
.... doseNumberPositiveInt 0..1positiveIntThe numeric/sequential number of the dose, when adequate

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... basedOn I0..1Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/basedOn
... administeredProduct I0..1CodeableConcept, Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/administeredProduct
... immunizationLocation I0..1CodeableConcept, Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/immunizationLocation
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SI1..*IdentifierThe clinical status of the immunization - whether it is active, resolved...
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI1..1stringThe value that is unique
Example General: 123456
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣI1..1codeThe status of this immunization record entry
Binding: ImmunizationStatusCodes (required)
... statusReason SI0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example)
... vaccineCode SΣI1..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
Binding: VaccineAdministeredValueSet (example)
... patient ΣI1..1Reference(Patient)The patient that this received immunization entry refers to
... encounter I0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] ΣI1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣI0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣI0..1stringVaccine administration date
... recorded SI0..1dateTimeThe date/time when the immunization event has been recorded
... primarySource ΣI0..1booleanIndicates context the data was recorded in
... reportOrigin I0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example)
... location SI0..1Reference(Location)Where immunization occurred
... manufacturer I0..1Reference(Organization)Vaccine manufacturer
... lotNumber SI0..1stringVaccine lot number
... expirationDate SI0..1dateVaccine expiration date
... site SI0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route SI0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity I0..1SimpleQuantityAmount of vaccine administered
... performer SΣI0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function ΣI0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor ΣI1..1Reference(Practitioner | Organization | PractitionerRole)Individual or organization who was performing
... note ΣI0..*AnnotationAdditional immunization notes
... reasonCode I0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!ΣI0..1booleanDose potency
... subpotentReason I0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example)
... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType I0..1stringEducational material document identifier
.... reference I0..1uriEducational material reference pointer
.... publicationDate I0..1dateTimeEducational material publication date
.... presentationDate I0..1dateTimeEducational material presentation date
... programEligibility I0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example)
... fundingSource I0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example)
... reaction SI0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date I0..1dateTimeWhen reaction started
.... detail I0..1Reference(Observation)Additional information on reaction
.... reported I0..1booleanIndicates self-reported reaction
... protocolApplied SI0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series I0..1stringName of vaccine series
.... authority I0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease I0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] I1..1(Slice Definition)Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumberStringstring
..... doseNumberPositiveIntpositiveInt
..... doseNumber[x]:doseNumberString I0..1stringWhether this is a first immunization or a reinforcement
..... doseNumber[x]:doseNumberPositiveInt I0..1positiveIntThe numeric/sequential number of the dose, when adequate
.... seriesDoses[x] I0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... basedOn 0..1Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/basedOn
... administeredProduct 0..1CodeableConcept, Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/administeredProduct
... identifier S1..*IdentifierThe clinical status of the immunization - whether it is active, resolved...
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... status S1..1codeThe status of this immunization record entry
... statusReason S0..1CodeableConceptReason not done
... vaccineCode S1..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
... patient 1..1Reference(Patient)The patient that this received immunization entry refers to
... occurrenceDateTime S0..1dateTimeVaccine administration date
... occurrenceString S0..1stringVaccine administration date
... recorded S0..1dateTimeThe date/time when the immunization event has been recorded
... location S0..1Reference(Location)Where immunization occurred
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
... route S0..1CodeableConceptHow vaccine entered body
... performer S0..*BackboneElementWho performed event
.... actor 1..1Reference(Practitioner | Organization | PractitionerRole)Individual or organization who was performing
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
... protocolApplied S0..*BackboneElementProtocol followed by the provider
.... doseNumberString 0..1stringWhether this is a first immunization or a reinforcement
.... doseNumberPositiveInt 0..1positiveIntThe numeric/sequential number of the dose, when adequate

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... basedOn I0..1Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/basedOn
... administeredProduct I0..1CodeableConcept, Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/administeredProduct
... immunizationLocation I0..1CodeableConcept, Reference()Extension
URL: https://www.hl7belgium.org/standards/fhir/StructureDefinition/immunizationLocation
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SI1..*IdentifierThe clinical status of the immunization - whether it is active, resolved...
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣI1..1stringThe value that is unique
Example General: 123456
.... period ΣI0..1PeriodTime period when id is/was valid for use
.... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... status ?!SΣI1..1codeThe status of this immunization record entry
Binding: ImmunizationStatusCodes (required)
... statusReason SI0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example)
... vaccineCode SΣI1..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
Binding: VaccineAdministeredValueSet (example)
... patient ΣI1..1Reference(Patient)The patient that this received immunization entry refers to
... encounter I0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] ΣI1..1(Slice Definition)Vaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrenceDateTimedateTime
.... occurrenceStringstring
.... occurrence[x]:occurrenceDateTime SΣI0..1dateTimeVaccine administration date
.... occurrence[x]:occurrenceString SΣI0..1stringVaccine administration date
... recorded SI0..1dateTimeThe date/time when the immunization event has been recorded
... primarySource ΣI0..1booleanIndicates context the data was recorded in
... reportOrigin I0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example)
... location SI0..1Reference(Location)Where immunization occurred
... manufacturer I0..1Reference(Organization)Vaccine manufacturer
... lotNumber SI0..1stringVaccine lot number
... expirationDate SI0..1dateVaccine expiration date
... site SI0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
... route SI0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example)
... doseQuantity I0..1SimpleQuantityAmount of vaccine administered
... performer SΣI0..*BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function ΣI0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
.... actor ΣI1..1Reference(Practitioner | Organization | PractitionerRole)Individual or organization who was performing
... note ΣI0..*AnnotationAdditional immunization notes
... reasonCode I0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example)
... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!ΣI0..1booleanDose potency
... subpotentReason I0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example)
... education I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType I0..1stringEducational material document identifier
.... reference I0..1uriEducational material reference pointer
.... publicationDate I0..1dateTimeEducational material publication date
.... presentationDate I0..1dateTimeEducational material presentation date
... programEligibility I0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example)
... fundingSource I0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example)
... reaction SI0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date I0..1dateTimeWhen reaction started
.... detail I0..1Reference(Observation)Additional information on reaction
.... reported I0..1booleanIndicates self-reported reaction
... protocolApplied SI0..*BackboneElementProtocol followed by the provider
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... series I0..1stringName of vaccine series
.... authority I0..1Reference(Organization)Who is responsible for publishing the recommendations
.... targetDisease I0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] I1..1(Slice Definition)Dose number within series
Slice: Unordered, Closed by type:$this
..... doseNumberStringstring
..... doseNumberPositiveIntpositiveInt
..... doseNumber[x]:doseNumberString I0..1stringWhether this is a first immunization or a reinforcement
..... doseNumber[x]:doseNumberPositiveInt I0..1positiveIntThe numeric/sequential number of the dose, when adequate
.... seriesDoses[x] I0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.identifier.userequiredIdentifierUse
Immunization.identifier.typeextensibleIdentifier Type Codes
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodeexampleVaccineAdministeredValueSet
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

Constraints

IdPathDetailsRequirements
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()