Dit profiel is het resultaat van de vergelijking tussen de zib2017 STU3 en zibs2020 R4 FHIR Profiel, relevante informatiestandarden en de implementaties in de ontsloten systemen en instellingen. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Vaccinaties

View Definition

ViewDefinition voor Vaccinaties

UI Wireframe

Vaccinaties

Gegevensherkomst

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
• ATC (CGM) - system=http://www.whocc.no/atc

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.

• 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	Vaccination Constraints: imm-2, imm-1
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization
Immunization.notGiven	?! This element is a modifier element. Σ This element is included in summaries.	1..1	boolean	Flag for whether immunization was given
Immunization.vaccineCode		1..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The code for vaccine product administered
Immunization.vaccineCode.Slices for coding	Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.Slices for coding.coding:All Slices				Content/Rules for all slices
Immunization.vaccineCode.Slices for coding.coding:All Slices.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.3.160 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient		1..1	Reference(nl-core-patient)	Who was immunized
Immunization.date	S This element must be supported.	1..1	dateTime	VaccinationDate
Immunization.primarySource		1..1	boolean	Indicates context the data was recorded in
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Vaccination notes
Immunization.note.text	S This element must be supported.	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.3
Immunization.vaccineCode.​coding:productCodeHPKCodelijst	Base	required	ProductCodeHPKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeZICodelijst	Base	required	ProductCodeZICodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeATCCodelijst	Base	required	ProductCodeATCCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodePRKCodelijst	Base	required	ProductCodePRKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeGTINCodelijst	Base	required	ProductCodeGTINCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3

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	Vaccination
Immunization.vaccineCode
Immunization.vaccineCode.coding
Immunization.vaccineCode.coding.display	S This element must be supported.	0..1	string	Representation defined by the system
Immunization.vaccineCode.text	S This element must be supported.	0..1	string	Plain text representation of the concept
Immunization.date	S This element must be supported.	1..1	dateTime	VaccinationDate
Immunization.note
Immunization.note.text	S This element must be supported.	1..1	string	Comment
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Zib Vaccination	Vaccination Constraints: imm-2, imm-1
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
Immunization.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
Immunization.contained		0..*	Resource	Contained, inline Resources
Immunization.extension		0..*	Extension	Additional Content defined by implementations
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization
Immunization.notGiven	?! This element is a modifier element. Σ This element is included in summaries.	1..1	boolean	Flag for whether immunization was given
Immunization.vaccineCode		1..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The code for vaccine product administered
Immunization.vaccineCode.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding	Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.Slices for coding.coding:All Slices				Content/Rules for all slices
Immunization.vaccineCode.Slices for coding.coding:All Slices.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:All Slices.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:All Slices.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Immunization.vaccineCode.Slices for coding.coding:All Slices.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:All Slices.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:All Slices.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:All Slices.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.3.160 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient		1..1	Reference(nl-core-patient)	Who was immunized
Immunization.encounter		0..1	Reference(HCIM Encounter)	Encounter administered as part of
Immunization.date	S This element must be supported.	1..1	dateTime	VaccinationDate
Immunization.primarySource		1..1	boolean	Indicates context the data was recorded in
Immunization.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.
Immunization.location		0..1	Reference(nl-core-location)	Where vaccination occurred
Immunization.manufacturer		0..1	Reference(nl-core-organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number
Immunization.expirationDate		0..1	date	Vaccine expiration date
Immunization.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
Immunization.route		0..1	CodeableConcept	How vaccine entered body Binding: Immunization Route Codes (example): The route by which the vaccine was administered
Immunization.doseQuantity	C	0..1	SimpleQuantity	Dose Constraints: sqty-1
Immunization.practitioner	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.practitioner.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.practitioner.extension		0..*	Extension	Additional Content defined by implementations
Immunization.practitioner.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.practitioner.role	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event
Immunization.practitioner.role.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.practitioner.role.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.practitioner.role.Slices for coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
Immunization.practitioner.role.Slices for coding.coding:healthProfessionalRole	Σ This element is included in summaries.	0..*	Coding	HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (required)
Immunization.practitioner.role.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.practitioner.actor	Σ This element is included in summaries.	1..1	Reference(nl-core-practitioner)	Administrator
Immunization.practitioner.actor.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.practitioner.actor.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.practitioner.actor.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Immunization.practitioner.actor.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Immunization.practitioner.actor.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.practitioner.actor.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Vaccination notes
Immunization.note.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.note.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.note.author[x]	Σ This element is included in summaries.	0..1		Individual responsible for the annotation
Immunization.note.author[x].authorReference			Reference(Practitioner | Patient | RelatedPerson)
Immunization.note.author[x].authorString			string
Immunization.note.time	Σ This element is included in summaries.	0..1	dateTime	When the annotation was made
Immunization.note.text	S This element must be supported.	1..1	string	Comment
Immunization.explanation		0..1	BackboneElement	Administration/non-administration reasons
Immunization.explanation.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.explanation.extension		0..*	Extension	Additional Content defined by implementations
Immunization.explanation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.explanation.reason		0..*	CodeableConcept	Why immunization occurred Binding: Immunization Reason Codes (example): The reason why a vaccine was administered
Immunization.explanation.reasonNotGiven		0..*	CodeableConcept	Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.reaction.extension		0..*	Extension	Additional Content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.reaction.date		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction
Immunization.vaccinationProtocol		0..*	BackboneElement	What protocol was followed
Immunization.vaccinationProtocol.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccinationProtocol.extension		0..*	Extension	Additional Content defined by implementations
Immunization.vaccinationProtocol.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.vaccinationProtocol.doseSequence		0..1	positiveInt	Dose number within series
Immunization.vaccinationProtocol.description		0..1	string	Details of vaccine protocol
Immunization.vaccinationProtocol.authority		0..1	Reference(Organization)	Who is responsible for protocol
Immunization.vaccinationProtocol.series		0..1	string	Name of vaccine series
Immunization.vaccinationProtocol.seriesDoses		0..1	positiveInt	Recommended number of doses for immunity
Immunization.vaccinationProtocol.targetDisease		1..*	CodeableConcept	Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol
Immunization.vaccinationProtocol.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)
Immunization.vaccinationProtocol.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.3
Immunization.vaccineCode.​coding:productCodeHPKCodelijst	Base	required	ProductCodeHPKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeZICodelijst	Base	required	ProductCodeZICodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeATCCodelijst	Base	required	ProductCodeATCCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodePRKCodelijst	Base	required	ProductCodePRKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeGTINCodelijst	Base	required	ProductCodeGTINCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
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.3
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()
sqty-1	error	Immunization.doseQuantity	The comparator is not used on a SimpleQuantity	comparator.empty()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Zib Vaccination	Vaccination Constraints: imm-2, imm-1
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization
Immunization.notGiven	?! This element is a modifier element. Σ This element is included in summaries.	1..1	boolean	Flag for whether immunization was given
Immunization.vaccineCode		1..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The code for vaccine product administered
Immunization.vaccineCode.Slices for coding	Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.Slices for coding.coding:All Slices				Content/Rules for all slices
Immunization.vaccineCode.Slices for coding.coding:All Slices.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.3.160 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient		1..1	Reference(nl-core-patient)	Who was immunized
Immunization.date	S This element must be supported.	1..1	dateTime	VaccinationDate
Immunization.primarySource		1..1	boolean	Indicates context the data was recorded in
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Vaccination notes
Immunization.note.text	S This element must be supported.	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.3
Immunization.vaccineCode.​coding:productCodeHPKCodelijst	Base	required	ProductCodeHPKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeZICodelijst	Base	required	ProductCodeZICodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeATCCodelijst	Base	required	ProductCodeATCCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodePRKCodelijst	Base	required	ProductCodePRKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeGTINCodelijst	Base	required	ProductCodeGTINCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3

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	Vaccination
Immunization.vaccineCode
Immunization.vaccineCode.coding
Immunization.vaccineCode.coding.display	S This element must be supported.	0..1	string	Representation defined by the system
Immunization.vaccineCode.text	S This element must be supported.	0..1	string	Plain text representation of the concept
Immunization.date	S This element must be supported.	1..1	dateTime	VaccinationDate
Immunization.note
Immunization.note.text	S This element must be supported.	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	Vaccination Constraints: imm-2, imm-1
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
Immunization.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
Immunization.contained		0..*	Resource	Contained, inline Resources
Immunization.extension		0..*	Extension	Additional Content defined by implementations
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error Binding: Immunization Status Codes (required): A set of codes indicating the current status of an Immunization
Immunization.notGiven	?! This element is a modifier element. Σ This element is included in summaries.	1..1	boolean	Flag for whether immunization was given
Immunization.vaccineCode		1..1	CodeableConcept	ProductCode Binding: Vaccine Administered Value Set (example): The code for vaccine product administered
Immunization.vaccineCode.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding	Σ This element is included in summaries.	1..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.vaccineCode.Slices for coding.coding:All Slices				Content/Rules for all slices
Immunization.vaccineCode.Slices for coding.coding:All Slices.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:All Slices.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:All Slices.system	Σ This element is included in summaries.	0..1	uri	Identity of the terminology system
Immunization.vaccineCode.Slices for coding.coding:All Slices.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:All Slices.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:All Slices.display	S This element must be supported. Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:All Slices.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGPKCodelijst (required): ProductCodeGPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.1 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGPKCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeHPKCodelijst (required): ProductCodeHPKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.7 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeHPKCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeZICodelijst (required): ProductCodeZICodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.8 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeZICodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeATCCodelijst (required): ProductCodeATCCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeATCCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodePRKCodelijst (required): ProductCodePRKCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:2.16.840.1.113883.2.4.4.10 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodePRKCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst	Σ This element is included in summaries.	0..1	Coding	Code defined by a terminology system Binding: ProductCodeGTINCodelijst (required): ProductCodeGTINCodelijst
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.system	Σ This element is included in summaries.	1..1	uri	Identity of the terminology system Fixed Value: urn:oid:1.3.160 (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.version	Σ This element is included in summaries.	0..1	string	Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.code	Σ This element is included in summaries.	0..1	code	Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.display	Σ This element is included in summaries.	0..1	string	Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:productCodeGTINCodelijst.userSelected	Σ This element is included in summaries.	0..1	boolean	If this coding was chosen directly by the user
Immunization.vaccineCode.text	S This element must be supported. Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.patient		1..1	Reference(nl-core-patient)	Who was immunized
Immunization.encounter		0..1	Reference(HCIM Encounter)	Encounter administered as part of
Immunization.date	S This element must be supported.	1..1	dateTime	VaccinationDate
Immunization.primarySource		1..1	boolean	Indicates context the data was recorded in
Immunization.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.
Immunization.location		0..1	Reference(nl-core-location)	Where vaccination occurred
Immunization.manufacturer		0..1	Reference(nl-core-organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number
Immunization.expirationDate		0..1	date	Vaccine expiration date
Immunization.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
Immunization.route		0..1	CodeableConcept	How vaccine entered body Binding: Immunization Route Codes (example): The route by which the vaccine was administered
Immunization.doseQuantity	C	0..1	SimpleQuantity	Dose Constraints: sqty-1
Immunization.practitioner	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.practitioner.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.practitioner.extension		0..*	Extension	Additional Content defined by implementations
Immunization.practitioner.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.practitioner.role	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: Immunization Role Codes (extensible): The role a practitioner plays in the immunization event
Immunization.practitioner.role.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.practitioner.role.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.practitioner.role.Slices for coding	Σ This element is included in summaries.	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by value:$this
Immunization.practitioner.role.Slices for coding.coding:healthProfessionalRole	Σ This element is included in summaries.	0..*	Coding	HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (required)
Immunization.practitioner.role.text	Σ This element is included in summaries.	0..1	string	Plain text representation of the concept
Immunization.practitioner.actor	Σ This element is included in summaries.	1..1	Reference(nl-core-practitioner)	Administrator
Immunization.practitioner.actor.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.practitioner.actor.Slices for extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.practitioner.actor.Slices for extension.extension:practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference Constraints: ext-1
Immunization.practitioner.actor.reference	Σ This element is included in summaries. C	0..1	string	Literal reference, Relative, internal or absolute URL
Immunization.practitioner.actor.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.practitioner.actor.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Vaccination notes
Immunization.note.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.note.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
Immunization.note.author[x]	Σ This element is included in summaries.	0..1		Individual responsible for the annotation
Immunization.note.author[x].authorReference			Reference(Practitioner | Patient | RelatedPerson)
Immunization.note.author[x].authorString			string
Immunization.note.time	Σ This element is included in summaries.	0..1	dateTime	When the annotation was made
Immunization.note.text	S This element must be supported.	1..1	string	Comment
Immunization.explanation		0..1	BackboneElement	Administration/non-administration reasons
Immunization.explanation.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.explanation.extension		0..*	Extension	Additional Content defined by implementations
Immunization.explanation.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.explanation.reason		0..*	CodeableConcept	Why immunization occurred Binding: Immunization Reason Codes (example): The reason why a vaccine was administered
Immunization.explanation.reasonNotGiven		0..*	CodeableConcept	Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example): The reason why a vaccine was not administered
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.reaction.extension		0..*	Extension	Additional Content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.reaction.date		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction
Immunization.vaccinationProtocol		0..*	BackboneElement	What protocol was followed
Immunization.vaccinationProtocol.id		0..1	string	xml:id (or equivalent in JSON)
Immunization.vaccinationProtocol.extension		0..*	Extension	Additional Content defined by implementations
Immunization.vaccinationProtocol.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
Immunization.vaccinationProtocol.doseSequence		0..1	positiveInt	Dose number within series
Immunization.vaccinationProtocol.description		0..1	string	Details of vaccine protocol
Immunization.vaccinationProtocol.authority		0..1	Reference(Organization)	Who is responsible for protocol
Immunization.vaccinationProtocol.series		0..1	string	Name of vaccine series
Immunization.vaccinationProtocol.seriesDoses		0..1	positiveInt	Recommended number of doses for immunity
Immunization.vaccinationProtocol.targetDisease		1..*	CodeableConcept	Disease immunized against Binding: Vaccination Protocol Dose Target Codes (example): The disease target of the vaccination protocol
Immunization.vaccinationProtocol.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)
Immunization.vaccinationProtocol.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.3
Immunization.vaccineCode.​coding:productCodeHPKCodelijst	Base	required	ProductCodeHPKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeZICodelijst	Base	required	ProductCodeZICodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeATCCodelijst	Base	required	ProductCodeATCCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodePRKCodelijst	Base	required	ProductCodePRKCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
Immunization.vaccineCode.​coding:productCodeGTINCodelijst	Base	required	ProductCodeGTINCodelijst	📦2017-12-31T00:00:00	Nictiz FHIR NL STU3 Zib2017 v2.3
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.3
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()
sqty-1	error	Immunization.doseQuantity	The comparator is not used on a SimpleQuantity	comparator.empty()

This structure is derived from Zib Vaccination

Summary

Must-Support: 4 elements