This is the set of resources that conform to either of the profiles Vaccination (http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization) and Vaccination (http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization). E.g. what you have to deal with if you get resources conforming to one of them
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | C | 0..* | Vaccination dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: ?? (extensible): A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | completed | entered-in-error Binding: ?? (required): A set of codes indicating the current status of an Immunization |
notGiven | ?!Σ | 1..1 | boolean | Flag for whether immunization was given |
vaccineCode | 1..1 | CodeableConcept | ProductCode Binding: ?? (example): The code for vaccine product administered | |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | Σ | 1..* | Coding | Code defined by a terminology system |
extension | 0..* | Extension | Additional Content defined by implementations | |
system | Σ | 0..1 | uri | Identity of the terminology system |
version | Σ | 0..1 | string | Version of the system - if relevant |
code | Σ | 0..1 | code | Symbol in syntax defined by the system |
display | SΣ | 0..1 | string | Representation defined by the system |
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
text | SΣ | 0..1 | string | Plain text representation of the concept |
patient | 1..1 | Reference(nl-core-patient) | Who was immunized | |
encounter | 0..1 | Reference(HCIM Encounter) | Encounter administered as part of | |
date | S | 1..1 | dateTime | VaccinationDate |
primarySource | 1..1 | boolean | Indicates context the data was recorded in | |
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | |
location | 0..1 | Reference(nl-core-location) | Where vaccination occurred | |
manufacturer | 0..1 | Reference(nl-core-organization) | Vaccine manufacturer | |
lotNumber | 0..1 | string | Vaccine lot number | |
expirationDate | 0..1 | date | Vaccine expiration date | |
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered | |
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered | |
doseQuantity | 0..1 | ?? | Dose | |
practitioner | Σ | 0..* | BackboneElement | Who performed event ele-1: All FHIR elements must have a @value or children |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
role | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner plays in the immunization event |
extension | 0..* | Extension | Additional Content defined by implementations | |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
text | Σ | 0..1 | string | Plain text representation of the concept |
actor | Σ | 1..1 | Reference(nl-core-practitioner) | Administrator |
extension | 0..* | Extension | Extension | |
reference | Σ | 0..1 | string | Literal reference, Relative, internal or absolute URL |
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
display | Σ | 0..1 | string | Text alternative for the resource |
note | Σ | 0..* | Annotation | Vaccination notes |
extension | 0..* | Extension | Additional Content defined by implementations | |
author[x] | Σ | 0..1 | Individual responsible for the annotation | |
authorReference | Reference(Practitioner | Patient | RelatedPerson) | |||
authorString | string | |||
time | Σ | 0..1 | dateTime | When the annotation was made |
text | S | 1..1 | string | Comment |
explanation | 0..1 | BackboneElement | Administration/non-administration reasons ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
reason | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered | |
reasonNotGiven | 0..* | CodeableConcept | Why immunization did not occur Binding: ?? (example): The reason why a vaccine was not administered | |
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
date | 0..1 | dateTime | When reaction started | |
detail | 0..1 | Reference(Observation) | Additional information on reaction | |
reported | 0..1 | boolean | Indicates self-reported reaction | |
vaccinationProtocol | 0..* | BackboneElement | What protocol was followed ele-1: All FHIR elements must have a @value or children | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
doseSequence | 0..1 | positiveInt | Dose number within series | |
description | 0..1 | string | Details of vaccine protocol | |
authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
series | 0..1 | string | Name of vaccine series | |
seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | |
targetDisease | 1..* | CodeableConcept | Disease immunized against Binding: ?? (example): The disease target of the vaccination protocol | |
doseStatus | 1..1 | CodeableConcept | Indicates if dose counts towards immunity Binding: ?? (example): The status of the vaccination protocol (i.e. should this count) | |
doseStatusReason | 0..1 | CodeableConcept | Why dose does (not) count Binding: ?? (example): The reason for the determining if a vaccination should count or why vaccination should not count. | |
Documentation for this format |