RIVO-Noord Zorgviewer Implementation Guide
1.21.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.21.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Vaccination

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization | Version: 1.21.0
Active as of 2025-10-28 | 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

ViewDefinition voor Vaccinaties

### UI Wireframe

Vaccinaties

>< | Bron | Datum | Product | Toelichting
--- | --- | --- | --- | ---
+ | Chipsoft | 5-3-1999 | HEPATITIS-A-VACCIN HAVRIX JR WSP 0,5ML (1440E/ML) | Bezoek aan Guatemala
+ | Epic | 2-8-2021 | COVID-19 Vaccin (Type Algemeen) |
+ | Nexus | 5-3-1999 | hepatitis-a-vaccin | Bezoek aan Guatemala.
+ | Epic | 29-7-2019 | Bof-/Mazelen-/Rubellavaccin |
+ | Epic | 25-3-2021 | COVID-19 Vaccin (Spikevax, Moderna) |

### Kolom Definities

Kolom label | FHIR Path Expression | 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 | `iif(exists(vaccineCode.text),vaccineCode.text,vaccineCode.coding.display)` | `string` | ProductCode |
Toelichting | `note.text` | `string` | Toelichting |

### Gebruikte waardelijsten

- ATC (Nexus) - `system=http://www.whocc.no/atc`
- NDC (Epic) - `system=http://hl7.org/fhir/sid/ndc`
- CVX (Epic) - `system=http://hl7.org/fhir/sid/cvx`
- G-Standaard Voorschrijfproducten (PRK) (Chipsoft) - `system=urn:oid:2.16.840.1.113883.2.4.4.10`

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

Usages:

- CapabilityStatements using this Profile: Ontsluiten Bronsysteem
- This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 1.20.0:

- The data elements list has changed

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization | C | 0..* | Zib Vaccination(2.1.5) | Vaccination Constraints: imm-2, imm-1
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
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
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(2.2.5)) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode.​coding:productCodeGPKCodelijst | Base | required | ProductCodeGPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeHPKCodelijst | Base | required | ProductCodeHPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeZICodelijst | Base | required | ProductCodeZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeATCCodelijst | Base | required | ProductCodeATCCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodePRKCodelijst | Base | required | ProductCodePRKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeGTINCodelijst | Base | required | ProductCodeGTINCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0

#### Constraints

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

This structure is derived from Zib Vaccination

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Zib Vaccination(2.1.5) | 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
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization | C | 0..* | Zib Vaccination(2.1.5) | Vaccination Constraints: imm-2, imm-1
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 Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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(2.2.5)) | Who was immunized
encounter |  | 0..1 | Reference(HCIM Encounter(2.1.6)) | 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(2.0.5)) | Where vaccination occurred
manufacturer |  | 0..1 | Reference(nl-core-organization(2.0.6)) | 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(2.0.7)) | Administrator
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole(2.0.7)) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
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.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | extensible | Common Languages | 📦3.0.2 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode.​coding:productCodeGPKCodelijst | Base | required | ProductCodeGPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeHPKCodelijst | Base | required | ProductCodeHPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeZICodelijst | Base | required | ProductCodeZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeATCCodelijst | Base | required | ProductCodeATCCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodePRKCodelijst | Base | required | ProductCodePRKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeGTINCodelijst | Base | required | ProductCodeGTINCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦3.0.2 | FHIR Std.
Immunization.site | Base | example | Codes for Immunization Site of Administration | 📦3.0.2 | FHIR Std.
Immunization.route | Base | example | Immunization Route Codes | 📦3.0.2 | FHIR Std.
Immunization.practitioner.​role | Base | extensible | Immunization Role Codes | 📦3.0.2 | FHIR Std.
Immunization.practitioner.​role.coding:healthProfessionalRole | Base | required | ZorgverlenerRolCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.explanation.​reason | Base | example | Immunization Reason Codes | 📦3.0.2 | FHIR Std.
Immunization.explanation.​reasonNotGiven | Base | example | Immunization Reasons for Not Immunizing Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccinationProtocol.​targetDisease | Base | example | Vaccination Protocol Dose Target Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccinationProtocol.​doseStatus | Base | example | Vaccination Protocol Dose Status codes | 📦3.0.2 | FHIR Std.
Immunization.vaccinationProtocol.​doseStatusReason | Base | example | Vaccination Protocol Dose Status Reason codes | 📦3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | 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-4 | error | Immunization | 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()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() | (children().count() > id.count())`
ext-1 | error | Immunization.practitioner.actor.extension:practitionerRole | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | `(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())`
imm-2 | error | Immunization | If 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization | C | 0..* | Zib Vaccination(2.1.5) | Vaccination Constraints: imm-2, imm-1
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
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
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(2.2.5)) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.status | Base | required | Immunization Status Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode.​coding:productCodeGPKCodelijst | Base | required | ProductCodeGPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeHPKCodelijst | Base | required | ProductCodeHPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeZICodelijst | Base | required | ProductCodeZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeATCCodelijst | Base | required | ProductCodeATCCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodePRKCodelijst | Base | required | ProductCodePRKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeGTINCodelijst | Base | required | ProductCodeGTINCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | 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-4 | error | Immunization | 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()`
imm-1 | error | Immunization | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | `(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())`
imm-2 | error | Immunization | If 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Zib Vaccination(2.1.5) | 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
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization | C | 0..* | Zib Vaccination(2.1.5) | Vaccination Constraints: imm-2, imm-1
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 Bindings | Purpose
All Languages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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(2.2.5)) | Who was immunized
encounter |  | 0..1 | Reference(HCIM Encounter(2.1.6)) | 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(2.0.5)) | Where vaccination occurred
manufacturer |  | 0..1 | Reference(nl-core-organization(2.0.6)) | 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(2.0.7)) | Administrator
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url
extension:practitionerRole |  | 0..1 | Reference(nl-core-practitionerrole(2.0.7)) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
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.
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | extensible | Common Languages | 📦3.0.2 | FHIR Std.
Immunization.status | Base | required | Immunization Status Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode | Base | example | Vaccine Administered Value Set | 📦3.0.2 | FHIR Std.
Immunization.vaccineCode.​coding:productCodeGPKCodelijst | Base | required | ProductCodeGPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeHPKCodelijst | Base | required | ProductCodeHPKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeZICodelijst | Base | required | ProductCodeZICodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeATCCodelijst | Base | required | ProductCodeATCCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodePRKCodelijst | Base | required | ProductCodePRKCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.vaccineCode.​coding:productCodeGTINCodelijst | Base | required | ProductCodeGTINCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.reportOrigin | Base | example | Immunization Origin Codes | 📦3.0.2 | FHIR Std.
Immunization.site | Base | example | Codes for Immunization Site of Administration | 📦3.0.2 | FHIR Std.
Immunization.route | Base | example | Immunization Route Codes | 📦3.0.2 | FHIR Std.
Immunization.practitioner.​role | Base | extensible | Immunization Role Codes | 📦3.0.2 | FHIR Std.
Immunization.practitioner.​role.coding:healthProfessionalRole | Base | required | ZorgverlenerRolCodelijst | 📦2017-12-31T00:00:00 | nictiz.fhir.nl.stu3.zib2017 v2.0
Immunization.explanation.​reason | Base | example | Immunization Reason Codes | 📦3.0.2 | FHIR Std.
Immunization.explanation.​reasonNotGiven | Base | example | Immunization Reasons for Not Immunizing Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccinationProtocol.​targetDisease | Base | example | Vaccination Protocol Dose Target Codes | 📦3.0.2 | FHIR Std.
Immunization.vaccinationProtocol.​doseStatus | Base | example | Vaccination Protocol Dose Status codes | 📦3.0.2 | FHIR Std.
Immunization.vaccinationProtocol.​doseStatusReason | Base | example | Vaccination Protocol Dose Status Reason codes | 📦3.0.2 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-1 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain any narrative | `contained.text.empty()`
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Immunization | 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-4 | error | Immunization | 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()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() | (children().count() > id.count())`
ext-1 | error | Immunization.practitioner.actor.extension:practitionerRole | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
imm-1 | error | Immunization | If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | `(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())`
imm-2 | error | Immunization | If 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