RIVO-Noord Zorgviewer Implementation Guide
1.23.0 - CI build

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

## Resource Profile: Vaccination - Detailed Descriptions

Active as of 2026-03-30

Definitions for the Immunization resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Immunization
Definition | Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed. This is the base resource type for everything.
Short | VaccinationBase Resource
Control | 0..*
Alternate Names | Vaccinatie
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`) imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. (`(notGiven = true) or explanation.reasonNotGiven.empty()`) imm-1: 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())`)
2. Immunization.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. Immunization.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
6. Immunization.status
Definition | Indicates the current status of the vaccination event.
Short | completed | entered-in-error
Comments | Will generally be set to show that the immunization has been completed. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from Immunization Status Codes http://hl7.org/fhir/ValueSet/immunization-status|3.0.2 (required to `http://hl7.org/fhir/ValueSet/immunization-status` ) A set of codes indicating the current status of an Immunization
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
8. Immunization.notGiven
Definition | Indicates if the vaccination was or was not given.
Short | Flag for whether immunization was given
Comments | This element is labeled as a modifier because it indicates that an immunization didn't happen.
Control | 1..1
Type | boolean
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
10. Immunization.vaccineCode
Definition | The product code of the vaccine administered. There are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines). Vaccine that was administered or was to be administered.
Short | ProductCodeVaccine product administered
Control | 1..1
Binding | For example codes, see Vaccine Administered Value Set http://hl7.org/fhir/ValueSet/vaccine-code|3.0.2 (example to `http://hl7.org/fhir/ValueSet/vaccine-code` ) The code for vaccine product administered
Type | CodeableConcept
Alternate Names | ProductCode
12. Immunization.vaccineCode.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 10..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
14. Immunization.vaccineCode.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
16. Immunization.vaccineCode.coding:productCodeGPKCodelijst
Slice Name | productCodeGPKCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Binding | The codes SHALL be taken from For codes, see ProductCodeGPKCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000` ) ProductCodeGPKCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
18. Immunization.vaccineCode.coding:productCodeGPKCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.1`
20. Immunization.vaccineCode.coding:productCodeHPKCodelijst
Slice Name | productCodeHPKCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Binding | The codes SHALL be taken from For codes, see ProductCodeHPKCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000` ) ProductCodeHPKCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
22. Immunization.vaccineCode.coding:productCodeHPKCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.7`
24. Immunization.vaccineCode.coding:productCodeZICodelijst
Slice Name | productCodeZICodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Binding | The codes SHALL be taken from For codes, see ProductCodeZICodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000` ) ProductCodeZICodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
26. Immunization.vaccineCode.coding:productCodeZICodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.8`
28. Immunization.vaccineCode.coding:productCodeATCCodelijst
Slice Name | productCodeATCCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Binding | The codes SHALL be taken from For codes, see ProductCodeATCCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000` ) ProductCodeATCCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
30. Immunization.vaccineCode.coding:productCodeATCCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://www.whocc.no/atc`
32. Immunization.vaccineCode.coding:productCodePRKCodelijst
Slice Name | productCodePRKCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Binding | The codes SHALL be taken from For codes, see ProductCodePRKCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000` ) ProductCodePRKCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
34. Immunization.vaccineCode.coding:productCodePRKCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.10`
36. Immunization.vaccineCode.coding:productCodeGTINCodelijst
Slice Name | productCodeGTINCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1*
Binding | The codes SHALL be taken from For codes, see ProductCodeGTINCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000` ) ProductCodeGTINCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
38. Immunization.vaccineCode.coding:productCodeGTINCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 10..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:1.3.160`
40. Immunization.vaccineCode.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
42. Immunization.patient
Definition | The patient who either received or did not receive the immunization.
Short | Who was immunized
Control | 1..1
Type | Reference(nl-core-patient, Patient)
44. Immunization.date
Definition | Date (and if possible time) that the vaccine was administered. Date vaccine administered or was to be administered.
Short | VaccinationDateVaccination administration date
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.
Control | 10..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Alternate Names | VaccinatieDatum
46. Immunization.primarySource
Definition | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
Short | Indicates context the data was recorded in
Comments | Reflects the “reliability” of the content.
Control | 1..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
48. Immunization.note
Definition | Extra information about the immunization that is not conveyed by the other attributes.
Short | Vaccination notes
Control | 0..*
Type | Annotation
Summary | true
50. Immunization.note.text
Definition | Free text explanation. Examples of commonly used explanations are: - "Vaccination according to the National Immunisation Program". - "Not according to the National Immunisation Program", followed by further explanation. - "Unknown" The text of the annotation.
Short | CommentThe annotation - text content
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Alternate Names | Toelichting

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

0. Immunization
2. Immunization.vaccineCode
4. Immunization.vaccineCode.coding
6. Immunization.vaccineCode.coding.display
Must Support | true
8. Immunization.vaccineCode.text
Must Support | true
10. Immunization.date
Must Support | true
12. Immunization.note
Added: 14. Immunization.note.text
Must Support | true

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

0. Immunization
Definition | Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
Short | Vaccination
Control | 0..*
Alternate Names | Vaccinatie
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`) imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. (`(notGiven = true) or explanation.reasonNotGiven.empty()`) imm-1: 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())`)
2. Immunization.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. Immunization.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Summary | true
6. Immunization.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
8. Immunization.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
All Languages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. Immunization.text
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
12. Immunization.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
14. Immunization.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
16. Immunization.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
18. Immunization.identifier
Definition | A unique identifier assigned to this immunization record.
Short | Business identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
20. Immunization.status
Definition | Indicates the current status of the vaccination event.
Short | completed | entered-in-error
Comments | Will generally be set to show that the immunization has been completed. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from Immunization Status Codes (required to `http://hl7.org/fhir/ValueSet/immunization-status` ) A set of codes indicating the current status of an Immunization
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
22. Immunization.notGiven
Definition | Indicates if the vaccination was or was not given.
Short | Flag for whether immunization was given
Comments | This element is labeled as a modifier because it indicates that an immunization didn't happen.
Control | 1..1
Type | boolean
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
24. Immunization.vaccineCode
Definition | The product code of the vaccine administered. There are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines).
Short | ProductCode
Control | 1..1
Binding | For example codes, see Vaccine Administered Value Set (example to `http://hl7.org/fhir/ValueSet/vaccine-code` ) The code for vaccine product administered
Type | CodeableConcept
Alternate Names | ProductCode
26. Immunization.vaccineCode.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
28. Immunization.vaccineCode.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
30. Immunization.vaccineCode.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ system
32. Immunization.vaccineCode.coding.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
34. Immunization.vaccineCode.coding.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
36. Immunization.vaccineCode.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 0..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
38. Immunization.vaccineCode.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
40. Immunization.vaccineCode.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
42. Immunization.vaccineCode.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
44. Immunization.vaccineCode.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
46. Immunization.vaccineCode.coding:productCodeGPKCodelijst
Slice Name | productCodeGPKCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Binding | The codes SHALL be taken from ProductCodeGPKCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000` ) ProductCodeGPKCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
48. Immunization.vaccineCode.coding:productCodeGPKCodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
50. Immunization.vaccineCode.coding:productCodeGPKCodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
52. Immunization.vaccineCode.coding:productCodeGPKCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.1`
54. Immunization.vaccineCode.coding:productCodeGPKCodelijst.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
56. Immunization.vaccineCode.coding:productCodeGPKCodelijst.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
58. Immunization.vaccineCode.coding:productCodeGPKCodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
60. Immunization.vaccineCode.coding:productCodeGPKCodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
62. Immunization.vaccineCode.coding:productCodeHPKCodelijst
Slice Name | productCodeHPKCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Binding | The codes SHALL be taken from ProductCodeHPKCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000` ) ProductCodeHPKCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
64. Immunization.vaccineCode.coding:productCodeHPKCodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
66. Immunization.vaccineCode.coding:productCodeHPKCodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
68. Immunization.vaccineCode.coding:productCodeHPKCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.7`
70. Immunization.vaccineCode.coding:productCodeHPKCodelijst.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
72. Immunization.vaccineCode.coding:productCodeHPKCodelijst.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
74. Immunization.vaccineCode.coding:productCodeHPKCodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
76. Immunization.vaccineCode.coding:productCodeHPKCodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
78. Immunization.vaccineCode.coding:productCodeZICodelijst
Slice Name | productCodeZICodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Binding | The codes SHALL be taken from ProductCodeZICodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000` ) ProductCodeZICodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
80. Immunization.vaccineCode.coding:productCodeZICodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
82. Immunization.vaccineCode.coding:productCodeZICodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
84. Immunization.vaccineCode.coding:productCodeZICodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.8`
86. Immunization.vaccineCode.coding:productCodeZICodelijst.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
88. Immunization.vaccineCode.coding:productCodeZICodelijst.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
90. Immunization.vaccineCode.coding:productCodeZICodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
92. Immunization.vaccineCode.coding:productCodeZICodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
94. Immunization.vaccineCode.coding:productCodeATCCodelijst
Slice Name | productCodeATCCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Binding | The codes SHALL be taken from ProductCodeATCCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000` ) ProductCodeATCCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
96. Immunization.vaccineCode.coding:productCodeATCCodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
98. Immunization.vaccineCode.coding:productCodeATCCodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
100. Immunization.vaccineCode.coding:productCodeATCCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `http://www.whocc.no/atc`
102. Immunization.vaccineCode.coding:productCodeATCCodelijst.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
104. Immunization.vaccineCode.coding:productCodeATCCodelijst.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
106. Immunization.vaccineCode.coding:productCodeATCCodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
108. Immunization.vaccineCode.coding:productCodeATCCodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
110. Immunization.vaccineCode.coding:productCodePRKCodelijst
Slice Name | productCodePRKCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Binding | The codes SHALL be taken from ProductCodePRKCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000` ) ProductCodePRKCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
112. Immunization.vaccineCode.coding:productCodePRKCodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
114. Immunization.vaccineCode.coding:productCodePRKCodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
116. Immunization.vaccineCode.coding:productCodePRKCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:2.16.840.1.113883.2.4.4.10`
118. Immunization.vaccineCode.coding:productCodePRKCodelijst.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
120. Immunization.vaccineCode.coding:productCodePRKCodelijst.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
122. Immunization.vaccineCode.coding:productCodePRKCodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
124. Immunization.vaccineCode.coding:productCodePRKCodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
126. Immunization.vaccineCode.coding:productCodeGTINCodelijst
Slice Name | productCodeGTINCodelijst
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..1
Binding | The codes SHALL be taken from ProductCodeGTINCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000` ) ProductCodeGTINCodelijst
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
128. Immunization.vaccineCode.coding:productCodeGTINCodelijst.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
130. Immunization.vaccineCode.coding:productCodeGTINCodelijst.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.vaccineCode.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
132. Immunization.vaccineCode.coding:productCodeGTINCodelijst.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Identity of the terminology system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be unambiguous about the source of the definition of the symbol.
Fixed Value | `urn:oid:1.3.160`
134. Immunization.vaccineCode.coding:productCodeGTINCodelijst.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
136. Immunization.vaccineCode.coding:productCodeGTINCodelijst.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
138. Immunization.vaccineCode.coding:productCodeGTINCodelijst.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
140. Immunization.vaccineCode.coding:productCodeGTINCodelijst.userSelected
Definition | Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
142. Immunization.vaccineCode.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
144. Immunization.patient
Definition | The patient who either received or did not receive the immunization.
Short | Who was immunized
Control | 1..1
Type | Reference(nl-core-patient)
146. Immunization.encounter
Definition | The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Short | Encounter administered as part of
Control | 0..1
Type | Reference(HCIM Encounter)
148. Immunization.date
Definition | Date (and if possible time) that the vaccine was administered.
Short | VaccinationDate
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.
Control | 1..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Alternate Names | VaccinatieDatum
150. Immunization.primarySource
Definition | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
Short | Indicates context the data was recorded in
Comments | Reflects the “reliability” of the content.
Control | 1..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
152. Immunization.reportOrigin
Definition | The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Short | Indicates the source of a secondarily reported record
Comments | Should not be populated if primarySource = True, will not be required even if primarySource = False.
Control | 0..1
Binding | For example codes, see Immunization Origin Codes (example to `http://hl7.org/fhir/ValueSet/immunization-origin` ) The source of the data for a record which is not from a primary source.
Type | CodeableConcept
154. Immunization.location
Definition | The service delivery location where the vaccine administration occurred.
Short | Where vaccination occurred
Control | 0..1
Type | Reference(nl-core-location)
156. Immunization.manufacturer
Definition | Name of vaccine manufacturer.
Short | Vaccine manufacturer
Control | 0..1
Type | Reference(nl-core-organization)
158. Immunization.lotNumber
Definition | Lot number of the vaccine product.
Short | Vaccine lot number
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
160. Immunization.expirationDate
Definition | Date vaccine batch expires.
Short | Vaccine expiration date
Control | 0..1
Type | date
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
162. Immunization.site
Definition | Body site where vaccine was administered.
Short | Body site vaccine was administered
Control | 0..1
Binding | For example codes, see Codes for Immunization Site of Administration (example to `http://hl7.org/fhir/ValueSet/immunization-site` ) The site at which the vaccine was administered
Type | CodeableConcept
164. Immunization.route
Definition | The path by which the vaccine product is taken into the body.
Short | How vaccine entered body
Control | 0..1
Binding | For example codes, see Immunization Route Codes (example to `http://hl7.org/fhir/ValueSet/immunization-route` ) The route by which the vaccine was administered
Type | CodeableConcept
166. Immunization.doseQuantity
Definition | The amount of product administered shown in milliliters. In most cases, the entire product is administered; in some cases, a described part of the product is administered.
Short | Dose
Control | 0..1
Type | Quantity(SimpleQuantity)
Alternate Names | Dosis
168. Immunization.practitioner
Definition | Indicates who or what performed the event.
Short | Who performed event
Control | 0..*
Type | BackboneElement
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
170. Immunization.practitioner.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
172. Immunization.practitioner.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
174. Immunization.practitioner.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
176. Immunization.practitioner.role
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.).
Short | What type of performance was done
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Immunization Role Codes (extensible to `http://hl7.org/fhir/ValueSet/immunization-role` ) The role a practitioner plays in the immunization event
Type | CodeableConcept
Summary | true
178. Immunization.practitioner.role.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
180. Immunization.practitioner.role.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.practitioner.role.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
182. Immunization.practitioner.role.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Slicing | This element introduces a set of slices on `Immunization.practitioner.role.coding`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
184. Immunization.practitioner.role.coding:healthProfessionalRole
Slice Name | healthProfessionalRole
Definition | The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner.
Short | HealthProfessionalRole
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Binding | The codes SHALL be taken from ZorgverlenerRolCodelijst (required to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000` )
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
Alternate Names | ZorgverlenerRol
186. Immunization.practitioner.role.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
188. Immunization.practitioner.actor
Definition | The healthcare provider and/or organization where or by whom the immunization was done.
Short | Administrator
Control | 1..1
Type | Reference(nl-core-practitioner)
Summary | true
Alternate Names | Toediener
190. Immunization.practitioner.actor.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
192. Immunization.practitioner.actor.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.practitioner.actor.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
194. Immunization.practitioner.actor.extension:practitionerRole
Slice Name | practitionerRole
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PractitionerRole Reference) (Extension Type: Reference(nl-core-practitionerrole))
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
196. Immunization.practitioner.actor.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
198. Immunization.practitioner.actor.identifier
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Summary | true
200. Immunization.practitioner.actor.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
202. Immunization.note
Definition | Extra information about the immunization that is not conveyed by the other attributes.
Short | Vaccination notes
Control | 0..*
Type | Annotation
Summary | true
204. Immunization.note.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
206. Immunization.note.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Immunization.note.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
208. Immunization.note.author[x]
Definition | The individual responsible for making the annotation.
Short | Individual responsible for the annotation
Control | 0..1
Type | Choice of: Reference(Practitioner, Patient, RelatedPerson), string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
210. Immunization.note.time
Definition | Indicates when this particular annotation was made.
Short | When the annotation was made
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
212. Immunization.note.text
Definition | Free text explanation. Examples of commonly used explanations are: - "Vaccination according to the National Immunisation Program". - "Not according to the National Immunisation Program", followed by further explanation. - "Unknown"
Short | Comment
Control | 1..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Alternate Names | Toelichting
214. Immunization.explanation
Definition | Reasons why a vaccine was or was not administered.
Short | Administration/non-administration reasons
Control | 0..1
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
216. Immunization.explanation.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
218. Immunization.explanation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
220. Immunization.explanation.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
222. Immunization.explanation.reason
Definition | Reasons why a vaccine was administered.
Short | Why immunization occurred
Control | 0..*
Binding | For example codes, see Immunization Reason Codes (example to `http://hl7.org/fhir/ValueSet/immunization-reason` ) The reason why a vaccine was administered
Type | CodeableConcept
224. Immunization.explanation.reasonNotGiven
Definition | Reason why a vaccine was not administered.
Short | Why immunization did not occur
Control | 0..*
Binding | For example codes, see Immunization Reasons for Not Immunizing Codes (example to `http://hl7.org/fhir/ValueSet/no-immunization-reason` ) The reason why a vaccine was not administered
Type | CodeableConcept
226. Immunization.reaction
Definition | Categorical data indicating that an adverse event is associated in time to an immunization.
Short | Details of a reaction that follows immunization
Comments | A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
228. Immunization.reaction.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
230. Immunization.reaction.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
232. Immunization.reaction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
234. Immunization.reaction.date
Definition | Date of reaction to the immunization.
Short | When reaction started
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
236. Immunization.reaction.detail
Definition | Details of the reaction.
Short | Additional information on reaction
Control | 0..1
Type | Reference(Observation)
238. Immunization.reaction.reported
Definition | Self-reported indicator.
Short | Indicates self-reported reaction
Control | 0..1
Type | boolean
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
240. Immunization.vaccinationProtocol
Definition | Contains information about the protocol(s) under which the vaccine was administered.
Short | What protocol was followed
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`)
242. Immunization.vaccinationProtocol.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
244. Immunization.vaccinationProtocol.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional Content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
246. Immunization.vaccinationProtocol.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Summary | true
Alternate Names | extensions, user content, modifiers
248. Immunization.vaccinationProtocol.doseSequence
Definition | Nominal position in a series.
Short | Dose number within series
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
250. Immunization.vaccinationProtocol.description
Definition | Contains the description about the protocol under which the vaccine was administered.
Short | Details of vaccine protocol
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
252. Immunization.vaccinationProtocol.authority
Definition | Indicates the authority who published the protocol. E.g. ACIP.
Short | Who is responsible for protocol
Control | 0..1
Type | Reference(Organization)
254. Immunization.vaccinationProtocol.series
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority.
Short | Name of vaccine series
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
256. Immunization.vaccinationProtocol.seriesDoses
Definition | The recommended number of doses to achieve immunity.
Short | Recommended number of doses for immunity
Control | 0..1
Type | positiveInt
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
258. Immunization.vaccinationProtocol.targetDisease
Definition | The targeted disease.
Short | Disease immunized against
Control | 1..*
Binding | For example codes, see Vaccination Protocol Dose Target Codes (example to `http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target` ) The disease target of the vaccination protocol
Type | CodeableConcept
260. Immunization.vaccinationProtocol.doseStatus
Definition | Indicates if the immunization event should "count" against the protocol.
Short | Indicates if dose counts towards immunity
Comments | May need to differentiate between status declarations by a provider vs. a CDS engine.
Control | 1..1
Binding | For example codes, see Vaccination Protocol Dose Status codes (example to `http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status` ) The status of the vaccination protocol (i.e. should this count)
Type | CodeableConcept
262. Immunization.vaccinationProtocol.doseStatusReason
Definition | Provides an explanation as to why an immunization event should or should not count against the protocol.
Short | Why dose does (not) count
Control | 0..1
Binding | For example codes, see Vaccination Protocol Dose Status Reason codes (example to `http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason` ) The reason for the determining if a vaccination should count or why vaccination should not count.
Type | CodeableConcept