Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

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

Resource Profile: HCIM Vaccination

Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination Version: 1.3.15
Active as of 2024-04-09 Computable Name: Zib Vaccination

Copyright/Legal: CC0

Vaccinatie as defined by the Dutch Health and Care Information models (Dutch: Zorginformatiebouwsteen or ZIB) Vaccination version 3.1, release 2017.

Immunization can be defined as ‘Generating natural immunity against pathogens by means of vaccination (active immunization) or by administering immunoglobulins (passive immunization)’.

Only vaccinations are included in this information model. Administering immunoglobulins is part of the medication overview. Vaccinations have lifelong relevance.

Most vaccinations are carried out in the Netherlands as part of the RVP (Rijksvaccinatieprogramma, National Immunisation Program). RVP information is especially important for children.

Vaccinations are also relevant for adult patients such as transplant patients, dialysis patients and patients with a post-splenectomy status. In addition, there are specific indications for the vaccination of risk groups, such as travelers, professionals who come into contact with blood or patients with wounds, weakened immune systems or heightened risk.

Documenting vaccinations that have already taken place in a patient is important for things such as the diagnostics of infectious diseases and the indication and planning of (re)vaccinations.

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Vaccination
... identifier 0..* Identifier Business identifier
... vaccineCode 1..1 CodeableConcept ProductCode
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:productCodeGPKCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst

..... coding:productCodeHPKCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst

..... coding:productCodeZICodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst

..... coding:productCodeATCCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst

..... coding:productCodePRKCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst

..... coding:productCodeGTINCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst

... patient 1..1 Reference(nl-core-patient) Who was immunized
... date 1..1 dateTime VaccinationDate
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
... location 0..1 Reference(nl-core-location) Where vaccination occurred
... manufacturer 0..1 Reference(nl-core-organization) Vaccine manufacturer
... doseQuantity 0..1 SimpleQuantity Dose
... practitioner 0..* BackboneElement Who performed event
.... role
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:healthProfessionalRole 0..* Coding HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible)
.... actor 1..1 Reference(nl-core-practitioner) Administrator
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... note 0..* Annotation Vaccination notes
.... text 1..1 string Comment

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCode.coding:productCodeGPKCodelijstextensibleProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeHPKCodelijstextensibleProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeZICodelijstextensibleProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeATCCodelijstextensibleProductCodeATCCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodePRKCodelijstextensibleProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeGTINCodelijstextensibleProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000
from this IG
Immunization.practitioner.role.coding:healthProfessionalRoleextensibleZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Vaccination
imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... 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:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst


..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst


..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst


..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst


..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst


..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst


... patient 1..1 Reference(nl-core-patient) Who was immunized
... encounter 0..1 Reference(HCIM Encounter) Encounter administered as part of
... date 1..1 dateTime VaccinationDate
... primarySource 1..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.

... location 0..1 Reference(nl-core-location) Where vaccination occurred
... manufacturer 0..1 Reference(nl-core-organization) Vaccine manufacturer
... doseQuantity 0..1 SimpleQuantity Dose
... practitioner Σ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor Σ 1..1 Reference(nl-core-practitioner) Administrator
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... note Σ 0..* Annotation Vaccination notes
.... text 1..1 string Comment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunization Status Codes
http://hl7.org/fhir/ValueSet/immunization-status
from the FHIR Standard
Immunization.vaccineCodeexampleVaccine Administered Value Set
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:productCodeGPKCodelijstextensibleProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeHPKCodelijstextensibleProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeZICodelijstextensibleProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeATCCodelijstextensibleProductCodeATCCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodePRKCodelijstextensibleProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeGTINCodelijstextensibleProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000
from this IG
Immunization.reportOriginexampleImmunization Origin Codes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
: (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
: (notGiven = true) or explanation.reasonNotGiven.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Vaccination
imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.

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

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

.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst


..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst


..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst


..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst


..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst


..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst


.... text Σ 0..1 string Plain text representation of the concept
... patient 1..1 Reference(nl-core-patient) Who was immunized
... encounter 0..1 Reference(HCIM Encounter) Encounter administered as part of
... date 1..1 dateTime VaccinationDate
... primarySource 1..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.

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

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

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

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


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


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


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

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


doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
: (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
: (notGiven = true) or explanation.reasonNotGiven.empty()

This structure is derived from Immunization

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.vaccineCode.coding
  • The element 1 is sliced based on the value of Immunization.practitioner.role.coding

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..* Immunization Vaccination
... identifier 0..* Identifier Business identifier
... vaccineCode 1..1 CodeableConcept ProductCode
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:productCodeGPKCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst

..... coding:productCodeHPKCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst

..... coding:productCodeZICodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst

..... coding:productCodeATCCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst

..... coding:productCodePRKCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst

..... coding:productCodeGTINCodelijst 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst

... patient 1..1 Reference(nl-core-patient) Who was immunized
... date 1..1 dateTime VaccinationDate
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
... location 0..1 Reference(nl-core-location) Where vaccination occurred
... manufacturer 0..1 Reference(nl-core-organization) Vaccine manufacturer
... doseQuantity 0..1 SimpleQuantity Dose
... practitioner 0..* BackboneElement Who performed event
.... role
..... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:healthProfessionalRole 0..* Coding HealthProfessionalRole
Binding: ZorgverlenerRolCodelijst (extensible)
.... actor 1..1 Reference(nl-core-practitioner) Administrator
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... note 0..* Annotation Vaccination notes
.... text 1..1 string Comment

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.vaccineCode.coding:productCodeGPKCodelijstextensibleProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeHPKCodelijstextensibleProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeZICodelijstextensibleProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeATCCodelijstextensibleProductCodeATCCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodePRKCodelijstextensibleProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeGTINCodelijstextensibleProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000
from this IG
Immunization.practitioner.role.coding:healthProfessionalRoleextensibleZorgverlenerRolCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C 0..* Immunization Vaccination
imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... 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:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst


..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst


..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst


..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst


..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst


..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst


... patient 1..1 Reference(nl-core-patient) Who was immunized
... encounter 0..1 Reference(HCIM Encounter) Encounter administered as part of
... date 1..1 dateTime VaccinationDate
... primarySource 1..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.

... location 0..1 Reference(nl-core-location) Where vaccination occurred
... manufacturer 0..1 Reference(nl-core-organization) Vaccine manufacturer
... doseQuantity 0..1 SimpleQuantity Dose
... practitioner Σ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... actor Σ 1..1 Reference(nl-core-practitioner) Administrator
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
... note Σ 0..* Annotation Vaccination notes
.... text 1..1 string Comment

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunization Status Codes
http://hl7.org/fhir/ValueSet/immunization-status
from the FHIR Standard
Immunization.vaccineCodeexampleVaccine Administered Value Set
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
Immunization.vaccineCode.coding:productCodeGPKCodelijstextensibleProductCodeGPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.1)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeHPKCodelijstextensibleProductCodeHPKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.7)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeZICodelijstextensibleProductCodeZICodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.8)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeATCCodelijstextensibleProductCodeATCCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodePRKCodelijstextensibleProductCodePRKCodelijst (a valid code from urn:oid:2.16.840.1.113883.2.4.4.10)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000
from this IG
Immunization.vaccineCode.coding:productCodeGTINCodelijstextensibleProductCodeGTINCodelijst (a valid code from urn:oid:1.3.160)
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000
from this IG
Immunization.reportOriginexampleImmunization Origin Codes
http://hl7.org/fhir/ValueSet/immunization-origin
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
: (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
: (notGiven = true) or explanation.reasonNotGiven.empty()

Snapshot View

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

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

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

.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:productCodeGPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGPKCodelijst (extensible): ProductCodeGPKCodelijst


..... coding:productCodeHPKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeHPKCodelijst (extensible): ProductCodeHPKCodelijst


..... coding:productCodeZICodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeZICodelijst (extensible): ProductCodeZICodelijst


..... coding:productCodeATCCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeATCCodelijst (extensible): ProductCodeATCCodelijst


..... coding:productCodePRKCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodePRKCodelijst (extensible): ProductCodePRKCodelijst


..... coding:productCodeGTINCodelijst Σ 0..1 Coding Code defined by a terminology system
Binding: ProductCodeGTINCodelijst (extensible): ProductCodeGTINCodelijst


.... text Σ 0..1 string Plain text representation of the concept
... patient 1..1 Reference(nl-core-patient) Who was immunized
... encounter 0..1 Reference(HCIM Encounter) Encounter administered as part of
... date 1..1 dateTime VaccinationDate
... primarySource 1..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: Immunization Origin Codes (example): The source of the data for a record which is not from a primary source.

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

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

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

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


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


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


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

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


doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
imm-1errorImmunizationIf immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
: (notGiven = true).not() or (reaction.empty() and explanation.reason.empty())
imm-2errorImmunizationIf immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
: (notGiven = true) or explanation.reasonNotGiven.empty()

This structure is derived from Immunization

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.vaccineCode.coding
  • The element 1 is sliced based on the value of Immunization.practitioner.role.coding

 

Other representations of profile: CSV, Excel, Schematron