RIVO-Noord Zorgviewer Implementation Guide
1.11.0 - sprint49 Netherlands flag

This page is part of the RIVO-Noord Zorgviewer Implementation Guide (v1.11.0: Release) based on FHIR (HL7® FHIR® Standard) R3. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Vaccination

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization Version: 1.11.0
Active as of 2025-01-20 Computable Name: Vaccination

Vaccinatie (Immunization)

Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Vaccinaties

View Definition

Kolom label FHIR Path FHIR Type Zib element Toelichting of regels
Bron .meta.extension("http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source").valueUri string nvt Lookup adhv uri (AGB-Z of OID) <adressering-base>/Organization?identifier=<.meta.tag.code> en gebruik dan Organization.name
Datum .date dateTime VaccinatieDatum
Product .vaccineCode.text string ProductCode
Toelichting .note.text string Toelichting

Request

  1. Opvragen (search) vaccinaties

    GET <ontsluiten-bronsysteem-base>/Immunization?patient=<fhir_patient_id>&status=completed

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Changes since version 1.10.0:

  • The data elements list has changed

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization C 0..* Zib Vaccination Vaccination
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code completed | entered-in-error
    Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization

    ... vaccineCode 1..1 CodeableConcept ProductCode
    Binding: Vaccine Administered Value Set (example): The code for vaccine product administered

    .... Slices for coding Σ 1..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:system
    ..... coding:All Slices Content/Rules for all slices
    ...... display SΣ 0..1 string Representation defined by the system
    ..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1
    ..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7
    ..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8
    ..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://www.whocc.no/atc
    ..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10
    ..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:1.3.160
    .... text SΣ 0..1 string Plain text representation of the concept
    ... patient 1..1 Reference(nl-core-patient) Who was immunized
    ... date S 1..1 dateTime VaccinationDate
    ... primarySource 1..1 boolean Indicates context the data was recorded in
    ... note Σ 0..* Annotation Vaccination notes
    .... text S 1..1 string Comment

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Immunization.statusrequiredImmunization Status Codes
    http://hl7.org/fhir/ValueSet/immunization-status
    from the FHIR Standard
    Immunization.vaccineCodeexampleVaccine Administered Value Set
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.vaccineCode.coding:productCodeGPKCodelijstrequiredProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
    Immunization.vaccineCode.coding:productCodeHPKCodelijstrequiredProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
    Immunization.vaccineCode.coding:productCodeZICodelijstrequiredProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
    Immunization.vaccineCode.coding:productCodeATCCodelijstrequiredProductCodeATCCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
    Immunization.vaccineCode.coding:productCodePRKCodelijstrequiredProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
    Immunization.vaccineCode.coding:productCodeGTINCodelijstrequiredProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
    : contained.text.empty()
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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()
    imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
    imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    : (notGiven = true) or explanation.reasonNotGiven.empty()

    This structure is derived from Zib Vaccination

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization 0..* Zib Vaccination Vaccination
    ... vaccineCode
    .... coding
    ..... display S 0..1 string Representation defined by the system
    .... text S 0..1 string Plain text representation of the concept
    ... date S 1..1 dateTime VaccinationDate
    ... note
    .... text S 1..1 string Comment

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization C 0..* Zib Vaccination Vaccination
    imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: Common Languages (extensible): A human language.

    Additional BindingsPurpose
    All Languages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional Content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier 0..* Identifier Business identifier
    ... status ?!Σ 1..1 code completed | entered-in-error
    Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization

    ... notGiven ?!Σ 1..1 boolean Flag for whether immunization was given
    ... vaccineCode 1..1 CodeableConcept ProductCode
    Binding: Vaccine Administered Value Set (example): The code for vaccine product administered

    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    .... Slices for coding Σ 1..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:system
    ..... coding:All Slices Content/Rules for all slices
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 0..1 uri Identity of the terminology system
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display SΣ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://www.whocc.no/atc
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:1.3.160
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    .... text SΣ 0..1 string Plain text representation of the concept
    ... patient 1..1 Reference(nl-core-patient) Who was immunized
    ... encounter 0..1 Reference(HCIM Encounter) Encounter administered as part of
    ... date S 1..1 dateTime VaccinationDate
    ... primarySource 1..1 boolean Indicates context the data was recorded in
    ... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
    Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.

    ... location 0..1 Reference(nl-core-location) Where vaccination occurred
    ... manufacturer 0..1 Reference(nl-core-organization) Vaccine manufacturer
    ... lotNumber 0..1 string Vaccine lot number
    ... expirationDate 0..1 date Vaccine expiration date
    ... site 0..1 CodeableConcept Body site vaccine was administered
    Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered

    ... route 0..1 CodeableConcept How vaccine entered body
    Binding: Immunization Route Codes (example): The route by which the vaccine was administered

    ... doseQuantity 0..1 SimpleQuantity Dose
    ... practitioner Σ 0..* BackboneElement Who performed event
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... role Σ 0..1 CodeableConcept What type of performance was done
    Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event

    ..... id 0..1 string xml:id (or equivalent in JSON)
    ..... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ..... Slices for coding Σ 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:$this
    ...... coding:healthProfessionalRole Σ 0..* Coding HealthProfessionalRole
    Binding: ZorgverlenerRolCodelijst (required)
    ..... text Σ 0..1 string Plain text representation of the concept
    .... actor Σ 1..1 Reference(nl-core-practitioner) Administrator
    ..... id 0..1 string xml:id (or equivalent in JSON)
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
    URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
    ..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
    ..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
    ..... display Σ 0..1 string Text alternative for the resource
    ... note Σ 0..* Annotation Vaccination notes
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    .... author[x] Σ 0..1 Individual responsible for the annotation
    ..... authorReference Reference(Practitioner | Patient | RelatedPerson)
    ..... authorString string
    .... time Σ 0..1 dateTime When the annotation was made
    .... text S 1..1 string Comment
    ... explanation 0..1 BackboneElement Administration/non-administration reasons
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... reason 0..* CodeableConcept Why immunization occurred
    Binding: Immunization Reason Codes (example): The reason why a vaccine was administered


    .... reasonNotGiven 0..* CodeableConcept Why immunization did not occur
    Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered


    ... reaction 0..* BackboneElement Details of a reaction that follows immunization
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... date 0..1 dateTime When reaction started
    .... detail 0..1 Reference(Observation) Additional information on reaction
    .... reported 0..1 boolean Indicates self-reported reaction
    ... vaccinationProtocol 0..* BackboneElement What protocol was followed
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... doseSequence 0..1 positiveInt Dose number within series
    .... description 0..1 string Details of vaccine protocol
    .... authority 0..1 Reference(Organization) Who is responsible for protocol
    .... series 0..1 string Name of vaccine series
    .... seriesDoses 0..1 positiveInt Recommended number of doses for immunity
    .... targetDisease 1..* CodeableConcept Disease immunized against
    Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol


    .... doseStatus 1..1 CodeableConcept Indicates if dose counts towards immunity
    Binding: Vaccination Protocol Dose Status codes (example): The status of the vaccination protocol (i.e. should this count)

    .... doseStatusReason 0..1 CodeableConcept Why dose does (not) count
    Binding: Vaccination Protocol Dose Status Reason codes (example): The reason for the determining if a vaccination should count or why vaccination should not count.


    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Immunization.languageextensibleCommon Languages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    All Languages Max Binding
    Immunization.statusrequiredImmunization Status Codes
    http://hl7.org/fhir/ValueSet/immunization-status
    from the FHIR Standard
    Immunization.vaccineCodeexampleVaccine Administered Value Set
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.vaccineCode.coding:productCodeGPKCodelijstrequiredProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
    Immunization.vaccineCode.coding:productCodeHPKCodelijstrequiredProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
    Immunization.vaccineCode.coding:productCodeZICodelijstrequiredProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
    Immunization.vaccineCode.coding:productCodeATCCodelijstrequiredProductCodeATCCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
    Immunization.vaccineCode.coding:productCodePRKCodelijstrequiredProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
    Immunization.vaccineCode.coding:productCodeGTINCodelijstrequiredProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000
    Immunization.reportOriginexampleImmunization Origin Codes
    http://hl7.org/fhir/ValueSet/immunization-origin
    from the FHIR Standard
    Immunization.siteexampleCodes for Immunization Site of Administration
    http://hl7.org/fhir/ValueSet/immunization-site
    from the FHIR Standard
    Immunization.routeexampleImmunization Route Codes
    http://hl7.org/fhir/ValueSet/immunization-route
    from the FHIR Standard
    Immunization.practitioner.roleextensibleImmunization Role Codes
    http://hl7.org/fhir/ValueSet/immunization-role
    from the FHIR Standard
    Immunization.practitioner.role.coding:healthProfessionalRolerequiredZorgverlenerRolCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000
    Immunization.explanation.reasonexampleImmunization Reason Codes
    http://hl7.org/fhir/ValueSet/immunization-reason
    from the FHIR Standard
    Immunization.explanation.reasonNotGivenexampleImmunization Reasons for Not Immunizing Codes
    http://hl7.org/fhir/ValueSet/no-immunization-reason
    from the FHIR Standard
    Immunization.vaccinationProtocol.targetDiseaseexampleVaccination Protocol Dose Target Codes
    http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target
    from the FHIR Standard
    Immunization.vaccinationProtocol.doseStatusexampleVaccination Protocol Dose Status codes
    http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status
    from the FHIR Standard
    Immunization.vaccinationProtocol.doseStatusReasonexampleVaccination Protocol Dose Status Reason codes
    http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
    : contained.text.empty()
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() | (children().count() > id.count())
    imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
    imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    : (notGiven = true) or explanation.reasonNotGiven.empty()

    This structure is derived from Zib Vaccination

    Summary

    Must-Support: 4 elements

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization C 0..* Zib Vaccination Vaccination
    dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... status ?!Σ 1..1 code completed | entered-in-error
    Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization

    ... vaccineCode 1..1 CodeableConcept ProductCode
    Binding: Vaccine Administered Value Set (example): The code for vaccine product administered

    .... Slices for coding Σ 1..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:system
    ..... coding:All Slices Content/Rules for all slices
    ...... display SΣ 0..1 string Representation defined by the system
    ..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1
    ..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7
    ..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8
    ..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://www.whocc.no/atc
    ..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10
    ..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst


    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:1.3.160
    .... text SΣ 0..1 string Plain text representation of the concept
    ... patient 1..1 Reference(nl-core-patient) Who was immunized
    ... date S 1..1 dateTime VaccinationDate
    ... primarySource 1..1 boolean Indicates context the data was recorded in
    ... note Σ 0..* Annotation Vaccination notes
    .... text S 1..1 string Comment

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Immunization.statusrequiredImmunization Status Codes
    http://hl7.org/fhir/ValueSet/immunization-status
    from the FHIR Standard
    Immunization.vaccineCodeexampleVaccine Administered Value Set
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.vaccineCode.coding:productCodeGPKCodelijstrequiredProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
    Immunization.vaccineCode.coding:productCodeHPKCodelijstrequiredProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
    Immunization.vaccineCode.coding:productCodeZICodelijstrequiredProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
    Immunization.vaccineCode.coding:productCodeATCCodelijstrequiredProductCodeATCCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
    Immunization.vaccineCode.coding:productCodePRKCodelijstrequiredProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
    Immunization.vaccineCode.coding:productCodeGTINCodelijstrequiredProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
    : contained.text.empty()
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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()
    imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
    imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    : (notGiven = true) or explanation.reasonNotGiven.empty()

    Differential View

    This structure is derived from Zib Vaccination

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization 0..* Zib Vaccination Vaccination
    ... vaccineCode
    .... coding
    ..... display S 0..1 string Representation defined by the system
    .... text S 0..1 string Plain text representation of the concept
    ... date S 1..1 dateTime VaccinationDate
    ... note
    .... text S 1..1 string Comment

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Immunization C 0..* Zib Vaccination Vaccination
    imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... language 0..1 code Language of the resource content
    Binding: Common Languages (extensible): A human language.

    Additional BindingsPurpose
    All Languages Max Binding
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional Content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier 0..* Identifier Business identifier
    ... status ?!Σ 1..1 code completed | entered-in-error
    Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization

    ... notGiven ?!Σ 1..1 boolean Flag for whether immunization was given
    ... vaccineCode 1..1 CodeableConcept ProductCode
    Binding: Vaccine Administered Value Set (example): The code for vaccine product administered

    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    .... Slices for coding Σ 1..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:system
    ..... coding:All Slices Content/Rules for all slices
    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 0..1 uri Identity of the terminology system
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display SΣ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: http://www.whocc.no/atc
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    ..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
    Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst


    ...... id 0..1 string xml:id (or equivalent in JSON)
    ...... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ...... system Σ 1..1 uri Identity of the terminology system
    Fixed Value: urn:oid:1.3.160
    ...... version Σ 0..1 string Version of the system - if relevant
    ...... code Σ 0..1 code Symbol in syntax defined by the system
    ...... display Σ 0..1 string Representation defined by the system
    ...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
    .... text SΣ 0..1 string Plain text representation of the concept
    ... patient 1..1 Reference(nl-core-patient) Who was immunized
    ... encounter 0..1 Reference(HCIM Encounter) Encounter administered as part of
    ... date S 1..1 dateTime VaccinationDate
    ... primarySource 1..1 boolean Indicates context the data was recorded in
    ... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
    Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.

    ... location 0..1 Reference(nl-core-location) Where vaccination occurred
    ... manufacturer 0..1 Reference(nl-core-organization) Vaccine manufacturer
    ... lotNumber 0..1 string Vaccine lot number
    ... expirationDate 0..1 date Vaccine expiration date
    ... site 0..1 CodeableConcept Body site vaccine was administered
    Binding: Codes for Immunization Site of Administration (example): The site at which the vaccine was administered

    ... route 0..1 CodeableConcept How vaccine entered body
    Binding: Immunization Route Codes (example): The route by which the vaccine was administered

    ... doseQuantity 0..1 SimpleQuantity Dose
    ... practitioner Σ 0..* BackboneElement Who performed event
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... role Σ 0..1 CodeableConcept What type of performance was done
    Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event

    ..... id 0..1 string xml:id (or equivalent in JSON)
    ..... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    ..... Slices for coding Σ 0..* Coding Code defined by a terminology system
    Slice: Unordered, Open by value:$this
    ...... coding:healthProfessionalRole Σ 0..* Coding HealthProfessionalRole
    Binding: ZorgverlenerRolCodelijst (required)
    ..... text Σ 0..1 string Plain text representation of the concept
    .... actor Σ 1..1 Reference(nl-core-practitioner) Administrator
    ..... id 0..1 string xml:id (or equivalent in JSON)
    ..... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    ...... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
    URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
    ..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
    ..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
    ..... display Σ 0..1 string Text alternative for the resource
    ... note Σ 0..* Annotation Vaccination notes
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    Slice: Unordered, Open by value:url
    .... author[x] Σ 0..1 Individual responsible for the annotation
    ..... authorReference Reference(Practitioner | Patient | RelatedPerson)
    ..... authorString string
    .... time Σ 0..1 dateTime When the annotation was made
    .... text S 1..1 string Comment
    ... explanation 0..1 BackboneElement Administration/non-administration reasons
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... reason 0..* CodeableConcept Why immunization occurred
    Binding: Immunization Reason Codes (example): The reason why a vaccine was administered


    .... reasonNotGiven 0..* CodeableConcept Why immunization did not occur
    Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered


    ... reaction 0..* BackboneElement Details of a reaction that follows immunization
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... date 0..1 dateTime When reaction started
    .... detail 0..1 Reference(Observation) Additional information on reaction
    .... reported 0..1 boolean Indicates self-reported reaction
    ... vaccinationProtocol 0..* BackboneElement What protocol was followed
    .... id 0..1 string xml:id (or equivalent in JSON)
    .... extension 0..* Extension Additional Content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
    .... doseSequence 0..1 positiveInt Dose number within series
    .... description 0..1 string Details of vaccine protocol
    .... authority 0..1 Reference(Organization) Who is responsible for protocol
    .... series 0..1 string Name of vaccine series
    .... seriesDoses 0..1 positiveInt Recommended number of doses for immunity
    .... targetDisease 1..* CodeableConcept Disease immunized against
    Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol


    .... doseStatus 1..1 CodeableConcept Indicates if dose counts towards immunity
    Binding: Vaccination Protocol Dose Status codes (example): The status of the vaccination protocol (i.e. should this count)

    .... doseStatusReason 0..1 CodeableConcept Why dose does (not) count
    Binding: Vaccination Protocol Dose Status Reason codes (example): The reason for the determining if a vaccination should count or why vaccination should not count.


    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSetURI
    Immunization.languageextensibleCommon Languages
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    Additional Bindings Purpose
    All Languages Max Binding
    Immunization.statusrequiredImmunization Status Codes
    http://hl7.org/fhir/ValueSet/immunization-status
    from the FHIR Standard
    Immunization.vaccineCodeexampleVaccine Administered Value Set
    http://hl7.org/fhir/ValueSet/vaccine-code
    from the FHIR Standard
    Immunization.vaccineCode.coding:productCodeGPKCodelijstrequiredProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
    Immunization.vaccineCode.coding:productCodeHPKCodelijstrequiredProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
    Immunization.vaccineCode.coding:productCodeZICodelijstrequiredProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
    Immunization.vaccineCode.coding:productCodeATCCodelijstrequiredProductCodeATCCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
    Immunization.vaccineCode.coding:productCodePRKCodelijstrequiredProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
    Immunization.vaccineCode.coding:productCodeGTINCodelijstrequiredProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000
    Immunization.reportOriginexampleImmunization Origin Codes
    http://hl7.org/fhir/ValueSet/immunization-origin
    from the FHIR Standard
    Immunization.siteexampleCodes for Immunization Site of Administration
    http://hl7.org/fhir/ValueSet/immunization-site
    from the FHIR Standard
    Immunization.routeexampleImmunization Route Codes
    http://hl7.org/fhir/ValueSet/immunization-route
    from the FHIR Standard
    Immunization.practitioner.roleextensibleImmunization Role Codes
    http://hl7.org/fhir/ValueSet/immunization-role
    from the FHIR Standard
    Immunization.practitioner.role.coding:healthProfessionalRolerequiredZorgverlenerRolCodelijst
    http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000
    Immunization.explanation.reasonexampleImmunization Reason Codes
    http://hl7.org/fhir/ValueSet/immunization-reason
    from the FHIR Standard
    Immunization.explanation.reasonNotGivenexampleImmunization Reasons for Not Immunizing Codes
    http://hl7.org/fhir/ValueSet/no-immunization-reason
    from the FHIR Standard
    Immunization.vaccinationProtocol.targetDiseaseexampleVaccination Protocol Dose Target Codes
    http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target
    from the FHIR Standard
    Immunization.vaccinationProtocol.doseStatusexampleVaccination Protocol Dose Status codes
    http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status
    from the FHIR Standard
    Immunization.vaccinationProtocol.doseStatusReasonexampleVaccination Protocol Dose Status Reason codes
    http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
    : contained.text.empty()
    dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
    : contained.contained.empty()
    dom-3errorImmunizationIf 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-4errorImmunizationIf 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()
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() | (children().count() > id.count())
    imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
    : (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
    imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
    : (notGiven = true) or explanation.reasonNotGiven.empty()

    This structure is derived from Zib Vaccination

    Summary

    Must-Support: 4 elements

     

    Other representations of profile: CSV, Excel, Schematron