Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Zib Vaccination - Detailed Descriptions

Active as of 2024-04-09

Definitions for the zib-Vaccination resource profile.

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

0. Immunization
ShortVaccination
Alternate NamesVaccinatie
2. Immunization.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
4. 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).

ShortProductCode
Alternate NamesProductCode
6. Immunization.vaccineCode.coding
Control1..?
SlicingThis element introduces a set of slices on Immunization.vaccineCode.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 8. Immunization.vaccineCode.coding:productCodeGPKCodelijst
    Slice NameproductCodeGPKCodelijst
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ProductCodeGPKCodelijst
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000)

    ProductCodeGPKCodelijst

    10. Immunization.vaccineCode.coding:productCodeHPKCodelijst
    Slice NameproductCodeHPKCodelijst
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ProductCodeHPKCodelijst
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000)

    ProductCodeHPKCodelijst

    12. Immunization.vaccineCode.coding:productCodeZICodelijst
    Slice NameproductCodeZICodelijst
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ProductCodeZICodelijst
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000)

    ProductCodeZICodelijst

    14. Immunization.vaccineCode.coding:productCodeATCCodelijst
    Slice NameproductCodeATCCodelijst
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ProductCodeATCCodelijst
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000)

    ProductCodeATCCodelijst

    16. Immunization.vaccineCode.coding:productCodePRKCodelijst
    Slice NameproductCodePRKCodelijst
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ProductCodePRKCodelijst
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000)

    ProductCodePRKCodelijst

    18. Immunization.vaccineCode.coding:productCodeGTINCodelijst
    Slice NameproductCodeGTINCodelijst
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from ProductCodeGTINCodelijst
    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000)

    ProductCodeGTINCodelijst

    20. Immunization.patient
    TypeReference(nl-core-patient)
    22. Immunization.encounter
    TypeReference(HCIM Encounter)
    24. Immunization.date
    Definition

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

    ShortVaccinationDate
    Control1..?
    Alternate NamesVaccinatieDatum
    26. Immunization.reportOrigin
    28. Immunization.location
    TypeReference(nl-core-location)
    30. Immunization.manufacturer
    TypeReference(nl-core-organization)
    32. Immunization.doseQuantity
    Definition

    The amount of product administered shown in milliliters. In most cases, the entire product is administered; in some cases, a described part of the product is administered.

    ShortDose
    Alternate NamesDosis
    34. Immunization.practitioner
    36. Immunization.practitioner.role
    38. Immunization.practitioner.role.coding
    SlicingThis element introduces a set of slices on Immunization.practitioner.role.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 40. Immunization.practitioner.role.coding:healthProfessionalRole
      Slice NamehealthProfessionalRole
      Definition

      The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner.

      ShortHealthProfessionalRole
      BindingUnless not suitable, these codes SHALL be taken from ZorgverlenerRolCodelijst
      (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000)
      Alternate NamesZorgverlenerRol
      42. Immunization.practitioner.actor
      Definition

      The healthcare provider and/or organization where or by whom the immunization was done.

      ShortAdministrator
      TypeReference(nl-core-practitioner)
      Alternate NamesToediener
      44. Immunization.practitioner.actor.extension
      SlicingThis element introduces a set of slices on Immunization.practitioner.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 46. Immunization.practitioner.actor.extension:practitionerRole
        Slice NamepractitionerRole
        Control0..1
        TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
        48. Immunization.note
        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"

        ShortComment
        Alternate NamesToelichting

        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.identifier
        Definition

        A unique identifier assigned to this immunization record.

        ShortBusiness identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        8. 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
        10. 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
        12. 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
        14. 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 are unordered and Open, and can be differentiated using the following discriminators:
        • value @ 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*
          BindingUnless not suitable, these codes SHALL be taken from For codes, see ProductCodeGPKCodelijst
          (extensible 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: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*
          BindingUnless not suitable, these codes SHALL be taken from For codes, see ProductCodeHPKCodelijst
          (extensible 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.

          20. 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*
          BindingUnless not suitable, these codes SHALL be taken from For codes, see ProductCodeZICodelijst
          (extensible 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.

          22. 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*
          BindingUnless not suitable, these codes SHALL be taken from For codes, see ProductCodeATCCodelijst
          (extensible 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.

          24. 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*
          BindingUnless not suitable, these codes SHALL be taken from For codes, see ProductCodePRKCodelijst
          (extensible 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.

          26. 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*
          BindingUnless not suitable, these codes SHALL be taken from For codes, see ProductCodeGTINCodelijst
          (extensible 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.

          28. Immunization.patient
          Definition

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

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

          The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

          ShortEncounter administered as part of
          Control0..1
          TypeReference(HCIM Encounter, Encounter)
          32. 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
          Alternate NamesVaccinatieDatum
          34. 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
          36. Immunization.reportOrigin
          Definition

          The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

          ShortIndicates the source of a secondarily reported record
          Comments

          Should not be populated if primarySource = True, will not be required even if primarySource = False.

          Control0..1
          BindingFor example codes, see Immunization Origin Codeshttp://hl7.org/fhir/ValueSet/immunization-origin
          (example to http://hl7.org/fhir/ValueSet/immunization-origin)

          The source of the data for a record which is not from a primary source.

          TypeCodeableConcept
          38. Immunization.location
          Definition

          The service delivery location where the vaccine administration occurred.

          ShortWhere vaccination occurred
          Control0..1
          TypeReference(nl-core-location, Location)
          40. Immunization.manufacturer
          Definition

          Name of vaccine manufacturer.

          ShortVaccine manufacturer
          Control0..1
          TypeReference(nl-core-organization, Organization)
          42. Immunization.doseQuantity
          Definition

          The amount of product administered shown in milliliters. In most cases, the entire product is administered; in some cases, a described part of the product is administered.


          The quantity of vaccine product that was administered.

          ShortDoseAmount of vaccine administered
          Control0..1
          TypeQuantity(SimpleQuantity)
          Alternate NamesDosis
          44. Immunization.practitioner
          Definition

          Indicates who or what performed the event.

          ShortWho performed event
          Control0..*
          TypeBackboneElement
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
          ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
          46. Immunization.practitioner.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element, 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
          Summarytrue
          Alternate Namesextensions, user content, modifiers
          48. Immunization.practitioner.actor
          Definition

          The healthcare provider and/or organization where or by whom the immunization was done.


          The device, practitioner, etc. who performed the action.

          ShortAdministratorIndividual who was performing
          Control1..1
          TypeReference(nl-core-practitioner, Practitioner)
          Summarytrue
          Alternate NamesToediener
          50. Immunization.practitioner.actor.extension
          Definition

          An Extension


          May be used to represent additional information that is not part of the basic definition of the element. 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.

          ShortExtensionAdditional Content defined by implementations
          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
          Alternate Namesextensions, user content
          SlicingThis element introduces a set of slices on Immunization.practitioner.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 52. Immunization.practitioner.actor.extension:practitionerRole
            Slice NamepractitionerRole
            Definition

            Optional Extension Element - found in all resources.

            ShortOptional Extensions Element
            Control0..1
            TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
            54. Immunization.note
            Definition

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

            ShortVaccination notes
            Control0..*
            TypeAnnotation
            Summarytrue
            56. 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
            Alternate NamesToelichting

            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.

            ShortVaccination
            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()))
            2. Immunization.id
            Definition

            The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

            ShortLogical id of this artifact
            Comments

            The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

            Control0..1
            Typeid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            4. Immunization.meta
            Definition

            The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Summarytrue
            6. 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
            8. Immunization.language
            Definition

            The base language in which the resource is written.

            ShortLanguage of the resource content
            Comments

            Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

            Control0..1
            BindingUnless not suitable, these codes SHALL be taken from Common Languages
            (extensible to http://hl7.org/fhir/ValueSet/languages)

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            10. Immunization.text
            Definition

            A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

            ShortText summary of the resource, for human interpretation
            Comments

            Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

            Control0..1
            This element is affected by the following invariants: dom-1
            TypeNarrative
            Alternate Namesnarrative, html, xhtml, display
            12. Immunization.contained
            Definition

            These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

            ShortContained, inline Resources
            Comments

            This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

            Control0..*
            TypeResource
            Alternate Namesinline resources, anonymous resources, contained resources
            14. Immunization.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource. 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.

            ShortAdditional Content defined by implementations
            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
            Alternate Namesextensions, user content
            16. 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
            18. Immunization.identifier
            Definition

            A unique identifier assigned to this immunization record.

            ShortBusiness identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            20. 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 Codes
            (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
            22. 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
            24. 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).

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

            The code for vaccine product administered

            TypeCodeableConcept
            Alternate NamesProductCode
            26. Immunization.vaccineCode.id
            Definition

            unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            28. Immunization.vaccineCode.extension
            Definition

            May be used to represent additional information that is not part of the basic definition of the element. 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.

            ShortAdditional Content defined by implementations
            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
            Alternate Namesextensions, user content
            SlicingThis element introduces a set of slices on Immunization.vaccineCode.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 30. 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.

              Control1..*
              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 are unordered and Open, and can be differentiated using the following discriminators:
              • value @ system
              • 32. 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
                BindingUnless not suitable, these codes SHALL be taken from ProductCodeGPKCodelijst
                (extensible 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.

                34. 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
                BindingUnless not suitable, these codes SHALL be taken from ProductCodeHPKCodelijst
                (extensible 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.

                36. 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
                BindingUnless not suitable, these codes SHALL be taken from ProductCodeZICodelijst
                (extensible 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.

                38. 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
                BindingUnless not suitable, these codes SHALL be taken from ProductCodeATCCodelijst
                (extensible 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.

                40. 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
                BindingUnless not suitable, these codes SHALL be taken from ProductCodePRKCodelijst
                (extensible 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.

                42. 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
                BindingUnless not suitable, these codes SHALL be taken from ProductCodeGTINCodelijst
                (extensible 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.

                44. 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
                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.

                46. Immunization.patient
                Definition

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

                ShortWho was immunized
                Control1..1
                TypeReference(nl-core-patient)
                48. Immunization.encounter
                Definition

                The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

                ShortEncounter administered as part of
                Control0..1
                TypeReference(HCIM Encounter)
                50. Immunization.date
                Definition

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

                ShortVaccinationDate
                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.

                Control1..1
                TypedateTime
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Alternate NamesVaccinatieDatum
                52. 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
                54. Immunization.reportOrigin
                Definition

                The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

                ShortIndicates the source of a secondarily reported record
                Comments

                Should not be populated if primarySource = True, will not be required even if primarySource = False.

                Control0..1
                BindingFor example codes, see Immunization Origin Codes
                (example to http://hl7.org/fhir/ValueSet/immunization-origin)

                The source of the data for a record which is not from a primary source.

                TypeCodeableConcept
                56. Immunization.location
                Definition

                The service delivery location where the vaccine administration occurred.

                ShortWhere vaccination occurred
                Control0..1
                TypeReference(nl-core-location)
                58. Immunization.manufacturer
                Definition

                Name of vaccine manufacturer.

                ShortVaccine manufacturer
                Control0..1
                TypeReference(nl-core-organization)
                60. Immunization.lotNumber
                Definition

                Lot number of the vaccine product.

                ShortVaccine lot number
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                62. Immunization.expirationDate
                Definition

                Date vaccine batch expires.

                ShortVaccine expiration date
                Control0..1
                Typedate
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                64. Immunization.site
                Definition

                Body site where vaccine was administered.

                ShortBody site vaccine was administered
                Control0..1
                BindingFor example codes, see Codes for Immunization Site of Administration
                (example to http://hl7.org/fhir/ValueSet/immunization-site)

                The site at which the vaccine was administered

                TypeCodeableConcept
                66. Immunization.route
                Definition

                The path by which the vaccine product is taken into the body.

                ShortHow vaccine entered body
                Control0..1
                BindingFor example codes, see Immunization Route Codes
                (example to http://hl7.org/fhir/ValueSet/immunization-route)

                The route by which the vaccine was administered

                TypeCodeableConcept
                68. Immunization.doseQuantity
                Definition

                The amount of product administered shown in milliliters. In most cases, the entire product is administered; in some cases, a described part of the product is administered.

                ShortDose
                Control0..1
                TypeQuantity(SimpleQuantity)
                Alternate NamesDosis
                70. Immunization.practitioner
                Definition

                Indicates who or what performed the event.

                ShortWho performed event
                Control0..*
                TypeBackboneElement
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                72. Immunization.practitioner.id
                Definition

                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                74. Immunization.practitioner.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. 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.

                ShortAdditional Content defined by implementations
                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
                Alternate Namesextensions, user content
                76. Immunization.practitioner.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element, 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
                Summarytrue
                Alternate Namesextensions, user content, modifiers
                78. Immunization.practitioner.role
                Definition

                Describes the type of performance (e.g. ordering provider, administering provider, etc.).

                ShortWhat type of performance was done
                Control0..1
                BindingUnless not suitable, these codes SHALL be taken from Immunization Role Codes
                (extensible to http://hl7.org/fhir/ValueSet/immunization-role)

                The role a practitioner plays in the immunization event

                TypeCodeableConcept
                Summarytrue
                80. Immunization.practitioner.role.id
                Definition

                unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                82. Immunization.practitioner.role.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element. 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.

                ShortAdditional Content defined by implementations
                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
                Alternate Namesextensions, user content
                SlicingThis element introduces a set of slices on Immunization.practitioner.role.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 84. Immunization.practitioner.role.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.

                  Control0..*
                  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.practitioner.role.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
                  • value @ system
                  • 86. Immunization.practitioner.role.coding:healthProfessionalRole
                    Slice NamehealthProfessionalRole
                    Definition

                    The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner.

                    ShortHealthProfessionalRole
                    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..*
                    BindingUnless not suitable, these codes SHALL be taken from ZorgverlenerRolCodelijst
                    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000)
                    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.

                    Alternate NamesZorgverlenerRol
                    88. Immunization.practitioner.role.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
                    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.

                    90. Immunization.practitioner.actor
                    Definition

                    The healthcare provider and/or organization where or by whom the immunization was done.

                    ShortAdministrator
                    Control1..1
                    TypeReference(nl-core-practitioner)
                    Summarytrue
                    Alternate NamesToediener
                    92. Immunization.practitioner.actor.id
                    Definition

                    unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    94. Immunization.practitioner.actor.extension
                    Definition

                    An Extension

                    ShortExtension
                    Control0..*
                    TypeExtension
                    SlicingThis element introduces a set of slices on Immunization.practitioner.actor.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 96. Immunization.practitioner.actor.extension:practitionerRole
                      Slice NamepractitionerRole
                      Definition

                      Optional Extension Element - found in all resources.

                      ShortOptional Extensions Element
                      Control0..1
                      TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
                      98. Immunization.practitioner.actor.reference
                      Definition

                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                      ShortLiteral reference, Relative, internal or absolute URL
                      Comments

                      Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                      Control0..1
                      This element is affected by the following invariants: ref-1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      100. Immunization.practitioner.actor.identifier
                      Definition

                      An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                      ShortLogical reference, when literal reference is not known
                      Comments

                      When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                      When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1
                      TypeIdentifier
                      Summarytrue
                      102. Immunization.practitioner.actor.display
                      Definition

                      Plain text narrative that identifies the resource in addition to the resource reference.

                      ShortText alternative for the resource
                      Comments

                      This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      104. Immunization.note
                      Definition

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

                      ShortVaccination notes
                      Control0..*
                      TypeAnnotation
                      Summarytrue
                      106. Immunization.note.id
                      Definition

                      unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      108. Immunization.note.extension
                      Definition

                      May be used to represent additional information that is not part of the basic definition of the element. 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.

                      ShortAdditional Content defined by implementations
                      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
                      Alternate Namesextensions, user content
                      SlicingThis element introduces a set of slices on Immunization.note.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 110. Immunization.note.author[x]
                        Definition

                        The individual responsible for making the annotation.

                        ShortIndividual responsible for the annotation
                        Control0..1
                        TypeChoice of: Reference(Practitioner, Patient, RelatedPerson), string
                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        112. Immunization.note.time
                        Definition

                        Indicates when this particular annotation was made.

                        ShortWhen the annotation was made
                        Control0..1
                        TypedateTime
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        114. 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"

                        ShortComment
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Alternate NamesToelichting
                        116. Immunization.explanation
                        Definition

                        Reasons why a vaccine was or was not administered.

                        ShortAdministration/non-administration reasons
                        Control0..1
                        TypeBackboneElement
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        118. Immunization.explanation.id
                        Definition

                        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        120. Immunization.explanation.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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.

                        ShortAdditional Content defined by implementations
                        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
                        Alternate Namesextensions, user content
                        122. Immunization.explanation.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element, 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
                        Summarytrue
                        Alternate Namesextensions, user content, modifiers
                        124. Immunization.explanation.reason
                        Definition

                        Reasons why a vaccine was administered.

                        ShortWhy immunization occurred
                        Control0..*
                        BindingFor example codes, see Immunization Reason Codes
                        (example to http://hl7.org/fhir/ValueSet/immunization-reason)

                        The reason why a vaccine was administered

                        TypeCodeableConcept
                        126. Immunization.explanation.reasonNotGiven
                        Definition

                        Reason why a vaccine was not administered.

                        ShortWhy immunization did not occur
                        Control0..*
                        BindingFor example codes, see Immunization Reasons for Not Immunizing Codes
                        (example to http://hl7.org/fhir/ValueSet/no-immunization-reason)

                        The reason why a vaccine was not administered

                        TypeCodeableConcept
                        128. Immunization.reaction
                        Definition

                        Categorical data indicating that an adverse event is associated in time to an immunization.

                        ShortDetails of a reaction that follows immunization
                        Comments

                        A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

                        Control0..*
                        TypeBackboneElement
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        130. Immunization.reaction.id
                        Definition

                        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        132. Immunization.reaction.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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.

                        ShortAdditional Content defined by implementations
                        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
                        Alternate Namesextensions, user content
                        134. Immunization.reaction.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element, 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
                        Summarytrue
                        Alternate Namesextensions, user content, modifiers
                        136. Immunization.reaction.date
                        Definition

                        Date of reaction to the immunization.

                        ShortWhen reaction started
                        Control0..1
                        TypedateTime
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        138. Immunization.reaction.detail
                        Definition

                        Details of the reaction.

                        ShortAdditional information on reaction
                        Control0..1
                        TypeReference(Observation)
                        140. Immunization.reaction.reported
                        Definition

                        Self-reported indicator.

                        ShortIndicates self-reported reaction
                        Control0..1
                        Typeboolean
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        142. Immunization.vaccinationProtocol
                        Definition

                        Contains information about the protocol(s) under which the vaccine was administered.

                        ShortWhat protocol was followed
                        Control0..*
                        TypeBackboneElement
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                        144. Immunization.vaccinationProtocol.id
                        Definition

                        unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        146. Immunization.vaccinationProtocol.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. 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.

                        ShortAdditional Content defined by implementations
                        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
                        Alternate Namesextensions, user content
                        148. Immunization.vaccinationProtocol.modifierExtension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element, 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
                        Summarytrue
                        Alternate Namesextensions, user content, modifiers
                        150. Immunization.vaccinationProtocol.doseSequence
                        Definition

                        Nominal position in a series.

                        ShortDose number within series
                        Control0..1
                        TypepositiveInt
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        152. Immunization.vaccinationProtocol.description
                        Definition

                        Contains the description about the protocol under which the vaccine was administered.

                        ShortDetails of vaccine protocol
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        154. Immunization.vaccinationProtocol.authority
                        Definition

                        Indicates the authority who published the protocol. E.g. ACIP.

                        ShortWho is responsible for protocol
                        Control0..1
                        TypeReference(Organization)
                        156. Immunization.vaccinationProtocol.series
                        Definition

                        One possible path to achieve presumed immunity against a disease - within the context of an authority.

                        ShortName of vaccine series
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        158. Immunization.vaccinationProtocol.seriesDoses
                        Definition

                        The recommended number of doses to achieve immunity.

                        ShortRecommended number of doses for immunity
                        Control0..1
                        TypepositiveInt
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        160. Immunization.vaccinationProtocol.targetDisease
                        Definition

                        The targeted disease.

                        ShortDisease immunized against
                        Control1..*
                        BindingFor example codes, see Vaccination Protocol Dose Target Codes
                        (example to http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target)

                        The disease target of the vaccination protocol

                        TypeCodeableConcept
                        162. Immunization.vaccinationProtocol.doseStatus
                        Definition

                        Indicates if the immunization event should "count" against the protocol.

                        ShortIndicates if dose counts towards immunity
                        Comments

                        May need to differentiate between status declarations by a provider vs. a CDS engine.

                        Control1..1
                        BindingFor example codes, see Vaccination Protocol Dose Status codes
                        (example to http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status)

                        The status of the vaccination protocol (i.e. should this count)

                        TypeCodeableConcept
                        164. Immunization.vaccinationProtocol.doseStatusReason
                        Definition

                        Provides an explanation as to why an immunization event should or should not count against the protocol.

                        ShortWhy dose does (not) count
                        Control0..1
                        BindingFor example codes, see Vaccination Protocol Dose Status Reason codes
                        (example to http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason)

                        The reason for the determining if a vaccination should count or why vaccination should not count.

                        TypeCodeableConcept