abstractbaseDefinitioncopyrightdescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurl| Left: | Vaccination (http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization) |
| Right: | Vaccination (http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination | ||
| copyright | |||
| description | Vaccinatie (Immunization) | ||
| experimental | |||
| fhirVersion | 3.0.2 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#NL | ||
| kind | resource | ||
| name | Vaccination | ||
| publisher | RIVO-NN HL7NL | ||
| purpose | |||
| status | active | ||
| title | Vaccination | ||
| type | Immunization | ||
| url | http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Immunization | C | 0..* | Zib Vaccination | Vaccination imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | C | 0..* | Zib Vaccination | Vaccination imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | |||||||||
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 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.
| 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier | 0..* | Identifier | Business 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 | ?!Σ | 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 | ?!Σ | 1..1 | boolean | Flag for whether immunization was given | |||||||||
 vaccineCode | 1..1 | CodeableConcept | ProductCode Binding: ?? (example): The code for vaccine product administered | 1..1 | CodeableConcept | ProductCode Binding: ?? (example): The code for vaccine product administered | |||||||||||
 id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| system | Σ | 0..1 | uri | Identity of the terminology system | Σ | 0..1 | uri | Identity of the terminology system | |||||||||
| version | Σ | 0..1 | string | Version of the system - if relevant | Σ | 0..1 | string | Version of the system - if relevant | |||||||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | Σ | 0..1 | code | Symbol in syntax defined by the system | |||||||||
| display | SΣ | 0..1 | string | Representation defined by the system | SΣ | 0..1 | string | Representation defined by the system | |||||||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | SΣ | 0..1 | string | Plain text representation of the concept | |||||||||
| patient | 1..1 | Reference(nl-core-patient) | Who was immunized | 1..1 | Reference(nl-core-patient) | Who was immunized | |||||||||||
| encounter | 0..1 | Reference(HCIM Encounter) | Encounter administered as part of | 0..1 | Reference(HCIM Encounter) | Encounter administered as part of | |||||||||||
| date | S | 1..1 | dateTime | VaccinationDate | S | 1..1 | dateTime | VaccinationDate | |||||||||
| primarySource | 1..1 | boolean | Indicates context the data was recorded in | 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. | 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 | 0..1 | Reference(nl-core-location) | Where vaccination occurred | |||||||||||
| manufacturer | 0..1 | Reference(nl-core-organization) | Vaccine manufacturer | 0..1 | Reference(nl-core-organization) | Vaccine manufacturer | |||||||||||
| lotNumber | 0..1 | string | Vaccine lot number | 0..1 | string | Vaccine lot number | |||||||||||
| expirationDate | 0..1 | date | Vaccine expiration date | 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 | 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 | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered | |||||||||||
| doseQuantity | 0..1 | ?? | Dose | 0..1 | ?? | Dose | |||||||||||
| practitioner | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 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 | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner plays in the immunization event | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |||||||||
| text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||
 actor | Σ | 1..1 | Reference(nl-core-practitioner) | Administrator | Σ | 1..1 | Reference(nl-core-practitioner) | Administrator | |||||||||
 id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||
| display | Σ | 0..1 | string | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource | |||||||||
| note | Σ | 0..* | Annotation | Vaccination notes | Σ | 0..* | Annotation | Vaccination notes | |||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| Slices for extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| author[x] | Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation | Σ | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation | |||||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | Σ | 0..1 | dateTime | When the annotation was made | |||||||||
| text | S | 1..1 | string | Comment | S | 1..1 | string | Comment | |||||||||
| explanation | 0..1 | BackboneElement | Administration/non-administration reasons | 0..1 | BackboneElement | Administration/non-administration reasons | |||||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| reason | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered | 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 | 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 | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| date | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||||||||||
| detail | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(Observation) | Additional information on reaction | |||||||||||
| reported | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
| vaccinationProtocol | 0..* | BackboneElement | What protocol was followed | 0..* | BackboneElement | What protocol was followed | |||||||||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||
| extension | 0..* | Extension | Additional Content defined by implementations | 0..* | Extension | Additional Content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| doseSequence | 0..1 | positiveInt | Dose number within series | 0..1 | positiveInt | Dose number within series | |||||||||||
| description | 0..1 | string | Details of vaccine protocol | 0..1 | string | Details of vaccine protocol | |||||||||||
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | 0..1 | Reference(Organization) | Who is responsible for protocol | |||||||||||
| series | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
| seriesDoses | 0..1 | positiveInt | Recommended number of doses for immunity | 0..1 | positiveInt | Recommended number of doses for immunity | |||||||||||
| targetDisease | 1..* | CodeableConcept | Disease immunized against Binding: ?? (example): The disease target of the vaccination protocol | 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) | 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. | 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 | |||||||||||||||||