RIVO-Noord Zorgviewer Implementation Guide
1.10.0 - sprint48 Netherlands flag

This page is part of the RIVO-Noord Zorgviewer Implementation Guide (v1.10.0: Release) based on FHIR (HL7® FHIR® Standard) R3. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Vaccination - Detailed Descriptions

Active as of 2025-01-20

Definitions for the Immunization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Immunization
Definition

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

ShortVaccinationImmunization event information
Control0..*
Alternate NamesVaccinatie
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. ((notGiven = true) or explanation.reasonNotGiven.empty())
imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present ((notGiven = true).not() or (reaction.empty() and explanation.reason.empty()))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. ((notGiven = true) or explanation.reasonNotGiven.empty())
imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present ((notGiven = true).not() or (reaction.empty() and explanation.reason.empty()))
2. Immunization.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. Immunization.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. Immunization.status
Definition

Indicates the current status of the vaccination event.

Shortcompleted | entered-in-error
Comments

Will generally be set to show that the immunization has been completed.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from Immunization Status Codeshttp://hl7.org/fhir/ValueSet/immunization-status
(required to http://hl7.org/fhir/ValueSet/immunization-status)

A set of codes indicating the current status of an Immunization

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. Immunization.notGiven
Definition

Indicates if the vaccination was or was not given.

ShortFlag for whether immunization was given
Comments

This element is labeled as a modifier because it indicates that an immunization didn't happen.

Control1..1
Typeboolean
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
10. Immunization.vaccineCode
Definition

The product code of the vaccine administered. There are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines).


Vaccine that was administered or was to be administered.

ShortProductCodeVaccine product administered
Control1..1
BindingFor example codes, see Vaccine Administered Value Sethttp://hl7.org/fhir/ValueSet/vaccine-code
(example to http://hl7.org/fhir/ValueSet/vaccine-code)

The code for vaccine product administered

TypeCodeableConcept
Alternate NamesProductCode
12. Immunization.vaccineCode.coding
Definition

A reference to a code defined by a terminology system.

ShortCode defined by a terminology system
Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control10..*
TypeCoding
Summarytrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

SlicingThis element introduces a set of slices on Immunization.vaccineCode.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 14. Immunization.vaccineCode.coding.display
    Definition

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortRepresentation defined by the system
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

    16. Immunization.vaccineCode.coding:productCodeGPKCodelijst
    Slice NameproductCodeGPKCodelijst
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see ProductCodeGPKCodelijst
    (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000)

    ProductCodeGPKCodelijst

    TypeCoding
    Summarytrue
    Requirements

    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

    18. Immunization.vaccineCode.coding:productCodeGPKCodelijst.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.1
    20. Immunization.vaccineCode.coding:productCodeHPKCodelijst
    Slice NameproductCodeHPKCodelijst
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see ProductCodeHPKCodelijst
    (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000)

    ProductCodeHPKCodelijst

    TypeCoding
    Summarytrue
    Requirements

    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

    22. Immunization.vaccineCode.coding:productCodeHPKCodelijst.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.7
    24. Immunization.vaccineCode.coding:productCodeZICodelijst
    Slice NameproductCodeZICodelijst
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see ProductCodeZICodelijst
    (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000)

    ProductCodeZICodelijst

    TypeCoding
    Summarytrue
    Requirements

    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

    26. Immunization.vaccineCode.coding:productCodeZICodelijst.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.8
    28. Immunization.vaccineCode.coding:productCodeATCCodelijst
    Slice NameproductCodeATCCodelijst
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see ProductCodeATCCodelijst
    (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000)

    ProductCodeATCCodelijst

    TypeCoding
    Summarytrue
    Requirements

    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

    30. Immunization.vaccineCode.coding:productCodeATCCodelijst.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valuehttp://www.whocc.no/atc
    32. Immunization.vaccineCode.coding:productCodePRKCodelijst
    Slice NameproductCodePRKCodelijst
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see ProductCodePRKCodelijst
    (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000)

    ProductCodePRKCodelijst

    TypeCoding
    Summarytrue
    Requirements

    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

    34. Immunization.vaccineCode.coding:productCodePRKCodelijst.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.10
    36. Immunization.vaccineCode.coding:productCodeGTINCodelijst
    Slice NameproductCodeGTINCodelijst
    Definition

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control0..1*
    BindingThe codes SHALL be taken from For codes, see ProductCodeGTINCodelijst
    (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000)

    ProductCodeGTINCodelijst

    TypeCoding
    Summarytrue
    Requirements

    Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

    38. Immunization.vaccineCode.coding:productCodeGTINCodelijst.system
    Definition

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

    Control10..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

    Fixed Valueurn:oid:1.3.160
    40. Immunization.vaccineCode.text
    Definition

    A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

    ShortPlain text representation of the concept
    Comments

    Very often the text is the same as a displayName of one of the codings.

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

    42. Immunization.patient
    Definition

    The patient who either received or did not receive the immunization.

    ShortWho was immunized
    Control1..1
    TypeReference(nl-core-patient, Patient)
    44. Immunization.date
    Definition

    Date (and if possible time) that the vaccine was administered.


    Date vaccine administered or was to be administered.

    ShortVaccinationDateVaccination administration date
    Comments

    When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known.  Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.

    Control10..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Alternate NamesVaccinatieDatum
    46. Immunization.primarySource
    Definition

    An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

    ShortIndicates context the data was recorded in
    Comments

    Reflects the “reliability” of the content.

    Control1..1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    48. Immunization.note
    Definition

    Extra information about the immunization that is not conveyed by the other attributes.

    ShortVaccination notes
    Control0..*
    TypeAnnotation
    Summarytrue
    50. Immunization.note.text
    Definition

    Free text explanation. Examples of commonly used explanations are: - "Vaccination according to the National Immunisation Program". - "Not according to the National Immunisation Program", followed by further explanation. - "Unknown"


    The text of the annotation.

    ShortCommentThe annotation - text content
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Alternate NamesToelichting