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

This is the logical model of the patient’s immunization entries in an immunization or vaccination record. The patient immunization record of several entries as modeled here.

The official URL for this profile is: 

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

Formal Views of Profile Content

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

This structure is derived from Resource

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraintsdoco
.. BEImmunization 0..*ResourceA record of an immunization or vaccination
... identifier 0..1IdentifierThe business identifier(s) for the immunization entry
... status 1..1codeThe status of this immunization record entry
... statusReason 0..1CodeableConceptThe reason for the status e.g. entered in error because ...
... vaccineCode 0..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
... dateTime 0..1dateTimeThe dateTime when the immunization has been recorded
... immunizationPlan 0..1Reference()The patient-specific order or recommendation for the immunization
... protocol 0..1Reference()The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling
... type 0..1codeThe type of immunization action - for example first dose or reinforcement.
... reporter 0..1Reference(BePractitioner)The professional that recorded the administration of the vaccine
... recorded 0..1dateTimeThe date and time when the administration of the vaccine was recorded
... performer 0..1Reference(BePractitioner)The professional that administered the medication
... route 0..1CodeableConceptThe route of administration.
... administeredProduct 0..1BackboneElementThe details of the product that was administered.
.... product 0..1CodeableReference()The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)
.... lotNumber 0..1stringThe lot number
.... expirationDate 0..1DateThe expiration date of the product.
... location 0..1CodeableReference()The location of the immunization.
... note 0..1AttachmentAdditional notes for the immunization.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. BEImmunization 0..*ResourceA record of an immunization or vaccination
... 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
... status 1..1codeThe status of this immunization record entry
... statusReason 0..1CodeableConceptThe reason for the status e.g. entered in error because ...
... patient 1..1Reference(BePatient)The patient that received immunization.
... vaccineCode 0..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
... dateTime 0..1dateTimeThe dateTime when the immunization has been recorded
... immunizationPlan 0..1Reference()The patient-specific order or recommendation for the immunization
... protocol 0..1Reference()The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling
... type 0..1codeThe type of immunization action - for example first dose or reinforcement.
... reporter 0..1Reference(BePractitioner)The professional that recorded the administration of the vaccine
... recorded 0..1dateTimeThe date and time when the administration of the vaccine was recorded
... performer 0..1Reference(BePractitioner)The professional that administered the medication
... route 0..1CodeableConceptThe route of administration.
... administeredProduct 0..1BackboneElementThe details of the product that was administered.
.... product 0..1CodeableReference()The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)
.... lotNumber 0..1stringThe lot number
.... expirationDate 0..1DateThe expiration date of the product.
... location 0..1CodeableReference()The location of the immunization.
... note 0..1AttachmentAdditional notes for the immunization.

doco Documentation for this format

This structure is derived from Resource

Summary

Mandatory: 0 element (2 nested mandatory elements)

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraintsdoco
.. BEImmunization 0..*ResourceA record of an immunization or vaccination
... identifier 0..1IdentifierThe business identifier(s) for the immunization entry
... status 1..1codeThe status of this immunization record entry
... statusReason 0..1CodeableConceptThe reason for the status e.g. entered in error because ...
... vaccineCode 0..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
... dateTime 0..1dateTimeThe dateTime when the immunization has been recorded
... immunizationPlan 0..1Reference()The patient-specific order or recommendation for the immunization
... protocol 0..1Reference()The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling
... type 0..1codeThe type of immunization action - for example first dose or reinforcement.
... reporter 0..1Reference(BePractitioner)The professional that recorded the administration of the vaccine
... recorded 0..1dateTimeThe date and time when the administration of the vaccine was recorded
... performer 0..1Reference(BePractitioner)The professional that administered the medication
... route 0..1CodeableConceptThe route of administration.
... administeredProduct 0..1BackboneElementThe details of the product that was administered.
.... product 0..1CodeableReference()The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)
.... lotNumber 0..1stringThe lot number
.... expirationDate 0..1DateThe expiration date of the product.
... location 0..1CodeableReference()The location of the immunization.
... note 0..1AttachmentAdditional notes for the immunization.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BEImmunization 0..*ResourceA record of an immunization or vaccination
... 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
... status 1..1codeThe status of this immunization record entry
... statusReason 0..1CodeableConceptThe reason for the status e.g. entered in error because ...
... patient 1..1Reference(BePatient)The patient that received immunization.
... vaccineCode 0..1CodeableConceptThe target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV
... dateTime 0..1dateTimeThe dateTime when the immunization has been recorded
... immunizationPlan 0..1Reference()The patient-specific order or recommendation for the immunization
... protocol 0..1Reference()The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling
... type 0..1codeThe type of immunization action - for example first dose or reinforcement.
... reporter 0..1Reference(BePractitioner)The professional that recorded the administration of the vaccine
... recorded 0..1dateTimeThe date and time when the administration of the vaccine was recorded
... performer 0..1Reference(BePractitioner)The professional that administered the medication
... route 0..1CodeableConceptThe route of administration.
... administeredProduct 0..1BackboneElementThe details of the product that was administered.
.... product 0..1CodeableReference()The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)
.... lotNumber 0..1stringThe lot number
.... expirationDate 0..1DateThe expiration date of the product.
... location 0..1CodeableReference()The location of the immunization.
... note 0..1AttachmentAdditional notes for the immunization.

doco Documentation for this format

 

​Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
BEImmunization.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

Constraints

IdPathDetailsRequirements