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 VaccinationRecommendation - Detailed Descriptions

Active as of 2025-09-22

Definitions for the zib-VaccinationRecommendation resource profile.

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

0. ImmunizationRecommendation
2. ImmunizationRecommendation.extension
SlicingThis element introduces a set of slices on ImmunizationRecommendation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. ImmunizationRecommendation.extension:orderStatus
    Slice NameorderStatus
    Definition

    The status of the order / recommendation.

    ShortOrderStatus
    Control0..1
    TypeExtension(HCIM VaccinationRecommendation OrderStatus) (Extension Type: CodeableConcept)
    Alternate NamesOrderStatus
    6. ImmunizationRecommendation.extension:orderStatus.valueCodeableConcept:valueCodeableConcept
    Slice NamevalueCodeableConcept
    8. ImmunizationRecommendation.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    10. ImmunizationRecommendation.patient
    TypeReference(nl-core-patient)
    12. ImmunizationRecommendation.recommendation
    14. ImmunizationRecommendation.recommendation.date
    Definition

    Date on which this vaccination will have to be repeated according to the author’s information.

    ShortDesiredDateForRevaccination
    Alternate NamesGewensteDatumHervaccinatie
    16. ImmunizationRecommendation.recommendation.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
    18. ImmunizationRecommendation.recommendation.vaccineCode.coding
    Control1..?
    SlicingThis element introduces a set of slices on ImmunizationRecommendation.recommendation.vaccineCode.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 20. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst
      Slice NameproductCodeGPKCodelijst
      Control0..1
      BindingThe codes SHALL be taken from ProductCodeGPKCodelijst
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000)

      ProductCodeGPKCodelijst

      22. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.system
      Control1..?
      Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.1
      24. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst
      Slice NameproductCodeHPKCodelijst
      Control0..1
      BindingThe codes SHALL be taken from ProductCodeHPKCodelijst
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000)

      ProductCodeHPKCodelijst

      26. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.system
      Control1..?
      Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.7
      28. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst
      Slice NameproductCodeZICodelijst
      Control0..1
      BindingThe codes SHALL be taken from ProductCodeZICodelijst
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000)

      ProductCodeZICodelijst

      30. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.system
      Control1..?
      Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.8
      32. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst
      Slice NameproductCodeATCCodelijst
      Control0..1
      BindingThe codes SHALL be taken from ProductCodeATCCodelijst
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000)

      ProductCodeATCCodelijst

      34. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.system
      Control1..?
      Fixed Valuehttp://www.whocc.no/atc
      36. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst
      Slice NameproductCodePRKCodelijst
      Control0..1
      BindingThe codes SHALL be taken from ProductCodePRKCodelijst
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000)

      ProductCodePRKCodelijst

      38. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.system
      Control1..?
      Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.10
      40. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst
      Slice NameproductCodeGTINCodelijst
      Control0..1
      BindingThe codes SHALL be taken from ProductCodeGTINCodelijst
      (required to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000)

      ProductCodeGTINCodelijst

      42. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.system
      Control1..?
      Fixed Valueurn:oid:1.3.160
      44. ImmunizationRecommendation.recommendation.dateCriterion
      ShortStartDate / EndDate
      Comments

      This element can be used to capture the StartDate and EndDate concepts of the HCIM PlannedCareActivityForTransfer.

      Alternate NamesStartDate, EndDate
      46. ImmunizationRecommendation.recommendation.protocol
      48. ImmunizationRecommendation.recommendation.protocol.authority
      TypeReference(nl-core-organization)
      50. ImmunizationRecommendation.recommendation.supportingImmunization
      TypeReference(HCIM Vaccination)
      52. ImmunizationRecommendation.recommendation.supportingPatientInformation
      TypeReference(HCIM AllergyIntolerance)

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

      0. ImmunizationRecommendation
      Definition

      A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.

      ShortGuidance or advice relating to an immunization
      Control0..*
      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())
      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())
      2. ImmunizationRecommendation.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. ImmunizationRecommendation.extension
      Definition

      An Extension


      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.

      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 ImmunizationRecommendation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. ImmunizationRecommendation.extension:orderStatus
        Slice NameorderStatus
        Definition

        The status of the order / recommendation.

        ShortOrderStatus
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeExtension(HCIM VaccinationRecommendation OrderStatus) (Extension Type: CodeableConcept)
        Alternate NamesOrderStatus
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        8. ImmunizationRecommendation.extension:orderStatus.url
        Definition

        Source of the definition for the extension code - a logical name or a URL.

        Shortidentifies the meaning of the extension
        Comments

        The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

        Control1..1
        Typeuri
        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.
        Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
        10. ImmunizationRecommendation.extension:orderStatus.value[x]
        Definition

        Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

        ShortValue of extension
        Control0..1
        TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        SlicingThis element introduces a set of slices on ImmunizationRecommendation.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • type @ $this
        • 12. ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept
          Slice NamevalueCodeableConcept
          Definition

          The status of the order / recommendation


          Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

          ShortOrderStatusValue of extension
          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from For codes, see OrderStatusCodelijst
          (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000)
          TypeCodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          14. ImmunizationRecommendation.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
          16. ImmunizationRecommendation.identifier
          Definition

          A unique identifier assigned to this particular recommendation record.

          ShortBusiness identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Summarytrue
          18. ImmunizationRecommendation.patient
          Definition

          The patient the recommendations are for.

          ShortWho this profile is for
          Control1..1
          TypeReference(nl-core-patient, Patient)
          Summarytrue
          20. ImmunizationRecommendation.recommendation
          Definition

          Vaccine administration recommendations.

          ShortVaccine administration recommendations
          Control1..*
          TypeBackboneElement
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
          imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists())
          ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
          imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists())
          22. ImmunizationRecommendation.recommendation.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
          24. ImmunizationRecommendation.recommendation.date
          Definition

          Date on which this vaccination will have to be repeated according to the author’s information.


          The date the immunization recommendation was created.

          ShortDesiredDateForRevaccinationDate recommendation created
          Control1..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Alternate NamesGewensteDatumHervaccinatie
          26. ImmunizationRecommendation.recommendation.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 pertains to the recommendation.

          ShortProductCodeVaccine recommendation applies to
          Control0..1
          BindingFor example codes, see Vaccine Administered Value Sethttp://hl7.org/fhir/ValueSet/vaccine-code|3.0.2
          (example to http://hl7.org/fhir/ValueSet/vaccine-code|3.0.2)

          The type of vaccine administered

          TypeCodeableConcept
          Summarytrue
          Alternate NamesProductCode
          28. ImmunizationRecommendation.recommendation.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 ImmunizationRecommendation.recommendation.vaccineCode.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 30. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst
            Slice NameproductCodeGPKCodelijst
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

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

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

            ProductCodeGPKCodelijst

            TypeCoding
            Summarytrue
            Requirements

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

            32. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.system
            Definition

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

            ShortIdentity of the terminology system
            Comments

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

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

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

            Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.1
            34. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst
            Slice NameproductCodeHPKCodelijst
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

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

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

            ProductCodeHPKCodelijst

            TypeCoding
            Summarytrue
            Requirements

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

            36. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.system
            Definition

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

            ShortIdentity of the terminology system
            Comments

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

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

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

            Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.7
            38. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst
            Slice NameproductCodeZICodelijst
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

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

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

            ProductCodeZICodelijst

            TypeCoding
            Summarytrue
            Requirements

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

            40. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.system
            Definition

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

            ShortIdentity of the terminology system
            Comments

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

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

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

            Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.8
            42. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst
            Slice NameproductCodeATCCodelijst
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

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

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

            ProductCodeATCCodelijst

            TypeCoding
            Summarytrue
            Requirements

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

            44. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.system
            Definition

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

            ShortIdentity of the terminology system
            Comments

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

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

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

            Fixed Valuehttp://www.whocc.no/atc
            46. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst
            Slice NameproductCodePRKCodelijst
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

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

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

            ProductCodePRKCodelijst

            TypeCoding
            Summarytrue
            Requirements

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

            48. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.system
            Definition

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

            ShortIdentity of the terminology system
            Comments

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

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

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

            Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.10
            50. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst
            Slice NameproductCodeGTINCodelijst
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

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

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

            ProductCodeGTINCodelijst

            TypeCoding
            Summarytrue
            Requirements

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

            52. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.system
            Definition

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

            ShortIdentity of the terminology system
            Comments

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

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

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

            Fixed Valueurn:oid:1.3.160
            54. ImmunizationRecommendation.recommendation.forecastStatus
            Definition

            Vaccine administration status.

            ShortVaccine administration status
            Control1..1
            BindingFor example codes, see Immunization Recommendation Status Codeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-status|3.0.2
            (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-status|3.0.2)

            The patient's status with respect to a vaccination protocol

            TypeCodeableConcept
            Summarytrue
            56. ImmunizationRecommendation.recommendation.dateCriterion
            Definition

            Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

            ShortStartDate / EndDateDates governing proposed immunization
            Comments

            This element can be used to capture the StartDate and EndDate concepts of the HCIM PlannedCareActivityForTransfer.

            Control0..*
            TypeBackboneElement
            Alternate NamesStartDate, EndDate
            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()))
            58. ImmunizationRecommendation.recommendation.dateCriterion.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
            60. ImmunizationRecommendation.recommendation.dateCriterion.code
            Definition

            Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

            ShortType of date
            Control1..1
            BindingFor example codes, see Immunization Recommendation Date Criterion Codeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion|3.0.2
            (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion|3.0.2)

            Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)

            TypeCodeableConcept
            62. ImmunizationRecommendation.recommendation.dateCriterion.value
            Definition

            The date whose meaning is specified by dateCriterion.code.

            ShortRecommended date
            Control1..1
            TypedateTime
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            64. ImmunizationRecommendation.recommendation.supportingImmunization
            Definition

            Immunization event history that supports the status and recommendation.

            ShortPast immunizations supporting recommendation
            Control0..*
            TypeReference(HCIM Vaccination, Immunization)
            66. ImmunizationRecommendation.recommendation.supportingPatientInformation
            Definition

            Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

            ShortPatient observations supporting recommendation
            Control0..*
            TypeReference(HCIM AllergyIntolerance, Observation, AllergyIntolerance)

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

            0. ImmunizationRecommendation
            Definition

            A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.

            ShortGuidance or advice relating to an immunization
            Control0..*
            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())
            2. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.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|3.0.2)

            A human language.

            Additional BindingsPurpose
            All LanguagesMax Binding
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            10. ImmunizationRecommendation.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. ImmunizationRecommendation.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. ImmunizationRecommendation.extension
            Definition

            An Extension

            ShortExtension
            Control0..*
            TypeExtension
            SlicingThis element introduces a set of slices on ImmunizationRecommendation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 16. ImmunizationRecommendation.extension:orderStatus
              Slice NameorderStatus
              Definition

              The status of the order / recommendation.

              ShortOrderStatus
              Control0..1
              This element is affected by the following invariants: ele-1
              TypeExtension(HCIM VaccinationRecommendation OrderStatus) (Extension Type: CodeableConcept)
              Alternate NamesOrderStatus
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              18. ImmunizationRecommendation.extension:orderStatus.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.
              20. ImmunizationRecommendation.extension:orderStatus.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 ImmunizationRecommendation.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 22. ImmunizationRecommendation.extension:orderStatus.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                Comments

                The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

                Control1..1
                Typeuri
                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.
                Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-VaccinationRecommendation-OrderStatus
                24. ImmunizationRecommendation.extension:orderStatus.value[x]
                Definition

                Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

                ShortValue of extension
                Control0..1
                TypeCodeableConcept
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                SlicingThis element introduces a set of slices on ImmunizationRecommendation.extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
                • type @ $this
                • 26. ImmunizationRecommendation.extension:orderStatus.value[x]:valueCodeableConcept
                  Slice NamevalueCodeableConcept
                  Definition

                  The status of the order / recommendation

                  ShortOrderStatus
                  Control0..1
                  BindingUnless not suitable, these codes SHALL be taken from OrderStatusCodelijst
                  (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000)
                  TypeCodeableConcept
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  28. ImmunizationRecommendation.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
                  30. ImmunizationRecommendation.identifier
                  Definition

                  A unique identifier assigned to this particular recommendation record.

                  ShortBusiness identifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  Summarytrue
                  32. ImmunizationRecommendation.patient
                  Definition

                  The patient the recommendations are for.

                  ShortWho this profile is for
                  Control1..1
                  TypeReference(nl-core-patient)
                  Summarytrue
                  34. ImmunizationRecommendation.recommendation
                  Definition

                  Vaccine administration recommendations.

                  ShortVaccine administration recommendations
                  Control1..*
                  TypeBackboneElement
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                  imr-1: One of vaccineCode or targetDisease SHALL be present (vaccineCode.exists() or targetDisease.exists())
                  36. ImmunizationRecommendation.recommendation.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.
                  38. ImmunizationRecommendation.recommendation.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
                  40. ImmunizationRecommendation.recommendation.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
                  42. ImmunizationRecommendation.recommendation.date
                  Definition

                  Date on which this vaccination will have to be repeated according to the author’s information.

                  ShortDesiredDateForRevaccination
                  Control1..1
                  TypedateTime
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Alternate NamesGewensteDatumHervaccinatie
                  44. ImmunizationRecommendation.recommendation.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
                  Control0..1
                  BindingFor example codes, see Vaccine Administered Value Set
                  (example to http://hl7.org/fhir/ValueSet/vaccine-code|3.0.2)

                  The type of vaccine administered

                  TypeCodeableConcept
                  Summarytrue
                  Alternate NamesProductCode
                  46. ImmunizationRecommendation.recommendation.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.
                  48. ImmunizationRecommendation.recommendation.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 ImmunizationRecommendation.recommendation.vaccineCode.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 50. ImmunizationRecommendation.recommendation.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 ImmunizationRecommendation.recommendation.vaccineCode.coding. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ system
                    • 52. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst
                      Slice NameproductCodeGPKCodelijst
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

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

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

                      ProductCodeGPKCodelijst

                      TypeCoding
                      Summarytrue
                      Requirements

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

                      54. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.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.
                      56. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.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 ImmunizationRecommendation.recommendation.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 58. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.system
                        Definition

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

                        ShortIdentity of the terminology system
                        Comments

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

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

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

                        Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.1
                        60. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.version
                        Definition

                        The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                        ShortVersion of the system - if relevant
                        Comments

                        Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                        NoteThis is a business version Id, not a resource version Id (see discussion)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        62. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.code
                        Definition

                        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                        ShortSymbol in syntax defined by the system
                        Control0..1
                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Need to refer to a particular code in the system.

                        64. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.display
                        Definition

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

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

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

                        66. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGPKCodelijst.userSelected
                        Definition

                        Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                        ShortIf this coding was chosen directly by the user
                        Comments

                        Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                        This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                        68. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst
                        Slice NameproductCodeHPKCodelijst
                        Definition

                        A reference to a code defined by a terminology system.

                        ShortCode defined by a terminology system
                        Comments

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

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

                        ProductCodeHPKCodelijst

                        TypeCoding
                        Summarytrue
                        Requirements

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

                        70. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.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.
                        72. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.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 ImmunizationRecommendation.recommendation.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 74. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.system
                          Definition

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

                          ShortIdentity of the terminology system
                          Comments

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

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

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

                          Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.7
                          76. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.version
                          Definition

                          The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                          ShortVersion of the system - if relevant
                          Comments

                          Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                          NoteThis is a business version Id, not a resource version Id (see discussion)
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          78. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.code
                          Definition

                          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                          ShortSymbol in syntax defined by the system
                          Control0..1
                          Typecode
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Requirements

                          Need to refer to a particular code in the system.

                          80. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.display
                          Definition

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

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

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

                          82. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeHPKCodelijst.userSelected
                          Definition

                          Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                          ShortIf this coding was chosen directly by the user
                          Comments

                          Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                          This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                          84. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst
                          Slice NameproductCodeZICodelijst
                          Definition

                          A reference to a code defined by a terminology system.

                          ShortCode defined by a terminology system
                          Comments

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

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

                          ProductCodeZICodelijst

                          TypeCoding
                          Summarytrue
                          Requirements

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

                          86. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.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.
                          88. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.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 ImmunizationRecommendation.recommendation.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 90. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.system
                            Definition

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

                            ShortIdentity of the terminology system
                            Comments

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

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

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

                            Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.8
                            92. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.version
                            Definition

                            The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                            ShortVersion of the system - if relevant
                            Comments

                            Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                            NoteThis is a business version Id, not a resource version Id (see discussion)
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            94. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.code
                            Definition

                            A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                            ShortSymbol in syntax defined by the system
                            Control0..1
                            Typecode
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to refer to a particular code in the system.

                            96. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.display
                            Definition

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

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

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

                            98. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeZICodelijst.userSelected
                            Definition

                            Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                            ShortIf this coding was chosen directly by the user
                            Comments

                            Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                            This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                            100. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst
                            Slice NameproductCodeATCCodelijst
                            Definition

                            A reference to a code defined by a terminology system.

                            ShortCode defined by a terminology system
                            Comments

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

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

                            ProductCodeATCCodelijst

                            TypeCoding
                            Summarytrue
                            Requirements

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

                            102. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.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.
                            104. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.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 ImmunizationRecommendation.recommendation.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 106. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.system
                              Definition

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

                              ShortIdentity of the terminology system
                              Comments

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

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

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

                              Fixed Valuehttp://www.whocc.no/atc
                              108. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.version
                              Definition

                              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                              ShortVersion of the system - if relevant
                              Comments

                              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                              NoteThis is a business version Id, not a resource version Id (see discussion)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              110. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.code
                              Definition

                              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                              ShortSymbol in syntax defined by the system
                              Control0..1
                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

                              112. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.display
                              Definition

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

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

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

                              114. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeATCCodelijst.userSelected
                              Definition

                              Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                              ShortIf this coding was chosen directly by the user
                              Comments

                              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                              116. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst
                              Slice NameproductCodePRKCodelijst
                              Definition

                              A reference to a code defined by a terminology system.

                              ShortCode defined by a terminology system
                              Comments

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

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

                              ProductCodePRKCodelijst

                              TypeCoding
                              Summarytrue
                              Requirements

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

                              118. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.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. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.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 ImmunizationRecommendation.recommendation.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 122. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.system
                                Definition

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

                                ShortIdentity of the terminology system
                                Comments

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

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

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

                                Fixed Valueurn:oid:2.16.840.1.113883.2.4.4.10
                                124. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.version
                                Definition

                                The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                ShortVersion of the system - if relevant
                                Comments

                                Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                126. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.code
                                Definition

                                A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                ShortSymbol in syntax defined by the system
                                Control0..1
                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Need to refer to a particular code in the system.

                                128. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.display
                                Definition

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

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

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

                                130. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodePRKCodelijst.userSelected
                                Definition

                                Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                                ShortIf this coding was chosen directly by the user
                                Comments

                                Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                132. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst
                                Slice NameproductCodeGTINCodelijst
                                Definition

                                A reference to a code defined by a terminology system.

                                ShortCode defined by a terminology system
                                Comments

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

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

                                ProductCodeGTINCodelijst

                                TypeCoding
                                Summarytrue
                                Requirements

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

                                134. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.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.
                                136. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.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 ImmunizationRecommendation.recommendation.vaccineCode.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 138. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.system
                                  Definition

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

                                  ShortIdentity of the terminology system
                                  Comments

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

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

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

                                  Fixed Valueurn:oid:1.3.160
                                  140. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.version
                                  Definition

                                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                                  ShortVersion of the system - if relevant
                                  Comments

                                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  142. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.code
                                  Definition

                                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                                  ShortSymbol in syntax defined by the system
                                  Control0..1
                                  Typecode
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  Requirements

                                  Need to refer to a particular code in the system.

                                  144. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.display
                                  Definition

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

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

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

                                  146. ImmunizationRecommendation.recommendation.vaccineCode.coding:productCodeGTINCodelijst.userSelected
                                  Definition

                                  Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                                  ShortIf this coding was chosen directly by the user
                                  Comments

                                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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

                                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                                  148. ImmunizationRecommendation.recommendation.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.

                                  150. ImmunizationRecommendation.recommendation.targetDisease
                                  Definition

                                  The targeted disease for the recommendation.

                                  ShortDisease to be immunized against
                                  Control0..1
                                  BindingFor example codes, see Immunization Recommendation Target Disease Codes
                                  (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-target-disease|3.0.2)

                                  The disease that the recommended vaccination targets

                                  TypeCodeableConcept
                                  Summarytrue
                                  152. ImmunizationRecommendation.recommendation.doseNumber
                                  Definition

                                  The next recommended dose number (e.g. dose 2 is the next recommended dose).

                                  ShortRecommended dose number
                                  Comments

                                  May need other dose concepts such as administered vs. valid.

                                  Control0..1
                                  TypepositiveInt
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  154. ImmunizationRecommendation.recommendation.forecastStatus
                                  Definition

                                  Vaccine administration status.

                                  ShortVaccine administration status
                                  Control1..1
                                  BindingFor example codes, see Immunization Recommendation Status Codes
                                  (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-status|3.0.2)

                                  The patient's status with respect to a vaccination protocol

                                  TypeCodeableConcept
                                  Summarytrue
                                  156. ImmunizationRecommendation.recommendation.dateCriterion
                                  Definition

                                  Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

                                  ShortStartDate / EndDate
                                  Comments

                                  This element can be used to capture the StartDate and EndDate concepts of the HCIM PlannedCareActivityForTransfer.

                                  Control0..*
                                  TypeBackboneElement
                                  Alternate NamesStartDate, EndDate
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  158. ImmunizationRecommendation.recommendation.dateCriterion.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.
                                  160. ImmunizationRecommendation.recommendation.dateCriterion.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
                                  162. ImmunizationRecommendation.recommendation.dateCriterion.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
                                  164. ImmunizationRecommendation.recommendation.dateCriterion.code
                                  Definition

                                  Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

                                  ShortType of date
                                  Control1..1
                                  BindingFor example codes, see Immunization Recommendation Date Criterion Codes
                                  (example to http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion|3.0.2)

                                  Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.)

                                  TypeCodeableConcept
                                  166. ImmunizationRecommendation.recommendation.dateCriterion.value
                                  Definition

                                  The date whose meaning is specified by dateCriterion.code.

                                  ShortRecommended date
                                  Control1..1
                                  TypedateTime
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  168. ImmunizationRecommendation.recommendation.protocol
                                  Definition

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

                                  ShortProtocol used by recommendation
                                  Control0..1
                                  TypeBackboneElement
                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  170. ImmunizationRecommendation.recommendation.protocol.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.
                                  172. ImmunizationRecommendation.recommendation.protocol.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
                                  174. ImmunizationRecommendation.recommendation.protocol.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
                                  176. ImmunizationRecommendation.recommendation.protocol.doseSequence
                                  Definition

                                  Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.

                                  ShortDose number within sequence
                                  Control0..1
                                  TypepositiveInt
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  178. ImmunizationRecommendation.recommendation.protocol.description
                                  Definition

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

                                  ShortProtocol details
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  180. ImmunizationRecommendation.recommendation.protocol.authority
                                  Definition

                                  Indicates the authority who published the protocol. For example, ACIP.

                                  ShortWho is responsible for protocol
                                  Control0..1
                                  TypeReference(nl-core-organization)
                                  182. ImmunizationRecommendation.recommendation.protocol.series
                                  Definition

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

                                  ShortName of vaccination series
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  184. ImmunizationRecommendation.recommendation.supportingImmunization
                                  Definition

                                  Immunization event history that supports the status and recommendation.

                                  ShortPast immunizations supporting recommendation
                                  Control0..*
                                  TypeReference(HCIM Vaccination)
                                  186. ImmunizationRecommendation.recommendation.supportingPatientInformation
                                  Definition

                                  Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

                                  ShortPatient observations supporting recommendation
                                  Control0..*
                                  TypeReference(HCIM AllergyIntolerance)