Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination-event | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibVaccinationevent | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
Immunization can be defined as “Generating natural immunity against pathogens by means of vaccination (active immunization) or by administering immunoglobulins (passive immunization)”.
Only the (administered and planned) vaccinations are included in this information model. Administering immunoglobulins is part of the medication overview. Vaccinations have lifelong relevance.
Most vaccinations are carried out in the Netherlands as part of the RVP (Rijksvaccinatieprogramma, National Immunisation Program). RVP information is especially important for children.
Vaccinations are also relevant for adult patients such as transplant patients, dialysis patients and patients with a post-splenectomy status. In addition, there are specific indications for the vaccination of risk groups, such as travelers, professionals who come into contact with blood or patients with wounds, weakened immune systems or heightened risk.
This Immunization resource represents the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) Vaccination v4.0 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization | 0..* | Immunization | This is an abstract profile. Child profiles: NlcoreVaccinationevent Vaccination | |
  status | 1..1 | code | completed | entered-in-error | not-done | |
| vaccineCode | 1..1 | CodeableConcept | ProductCode Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 (required) | |
  Slices for occurrence[x] | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this | |
   occurrence[x]:occurrenceDateTime | 1..1 | dateTime | VaccinationDate | |
| doseQuantity | 0..1 | SimpleQuantity | Dose Required Pattern: At least the following | |
  system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| Slices for performer | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:function | |
 performer:administrator | 0..1 | BackboneElement | Who performed event | |
  function | 1..1 | CodeableConcept | What type of performance was done Required Pattern: At least the following | |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
  actor | 1..1 | PatternZibHealthProfessionalReference(Practitioner | PractitionerRole | Organization | zib HealthProfessional PractitionerRole) | Administrator | |
| note | 0..1 | Annotation | Additional immunization notes | |
| text | 1..1 | markdown | Comment | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Immunization.vaccineCode | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Immunization | This is an abstract profile. Child profiles: NlcoreVaccinationevent Vaccination | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
 vaccineCode | Σ | 1..1 | CodeableConcept | ProductCode Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 (required) |
| patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
| Slices for occurrence[x] | Σ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
 occurrenceDateTime | dateTime | |||
| occurrenceString | string | |||
| occurrence[x]:occurrenceDateTime | Σ | 1..1 | dateTime | VaccinationDate |
| doseQuantity | 0..1 | SimpleQuantity | Dose Required Pattern: At least the following | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:function |
 performer:All Slices | Content/Rules for all slices | |||
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| performer:administrator | Σ | 0..1 | BackboneElement | Who performed event |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | Σ | 1..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor | Σ | 1..1 | PatternZibHealthProfessionalReference(Practitioner | PractitionerRole | Organization | zib HealthProfessional PractitionerRole) | Administrator |
| note | Σ | 0..1 | Annotation | Additional immunization notes |
| text | Σ | 1..1 | markdown | Comment |
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Immunization.status | required | ImmunizationStatusCodes |
| Immunization.vaccineCode | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 |
| Immunization.performer:administrator.function | extensible | Pattern: AP |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | 0..* | Immunization | This is an abstract profile. Child profiles: NlcoreVaccinationevent Vaccination | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
| vaccineCode | Σ | 1..1 | CodeableConcept | ProductCode Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 (required) | ||||
| patient | Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| Slices for occurrence[x] | Σ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrenceString | string | |||||||
| occurrence[x]:occurrenceDateTime | Σ | 1..1 | dateTime | VaccinationDate | ||||
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location | 0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer | 0..1 | Reference(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: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity | 0..1 | SimpleQuantity | Dose Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
| unit | 0..1 | string | Unit representation | |||||
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
| code | 0..1 | code | Coded form of the unit | |||||
| Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:function | ||||
| performer:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| performer:administrator | Σ | 0..1 | BackboneElement | Who performed event | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 1..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| actor | Σ | 1..1 | PatternZibHealthProfessionalReference(Practitioner | PractitionerRole | Organization | zib HealthProfessional PractitionerRole) | Administrator | ||||
| note | Σ | 0..1 | Annotation | Additional immunization notes | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | Comment | ||||
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education | C | 0..* | BackboneElement | Educational material presented to patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType | 0..1 | string | Educational material document identifier | |||||
| reference | 0..1 | uri | Educational material reference pointer | |||||
| publicationDate | 0..1 | dateTime | Educational material publication date | |||||
| presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
| programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date | 0..1 | dateTime | When reaction started | |||||
| detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported | 0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series | 0..1 | string | Name of vaccine series | |||||
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] | 1..1 | Dose number within series | ||||||
| doseNumberPositiveInt | positiveInt | |||||||
| doseNumberString | string | |||||||
| seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt | positiveInt | |||||||
| seriesDosesString | string | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Immunization.language | preferred | CommonLanguages
| ||||
| Immunization.status | required | ImmunizationStatusCodes | ||||
| Immunization.statusReason | example | ImmunizationStatusReasonCodes | ||||
| Immunization.vaccineCode | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodes | ||||
| Immunization.site | example | CodesForImmunizationSiteOfAdministration | ||||
| Immunization.route | example | ImmunizationRouteCodes | ||||
| Immunization.performer.function | extensible | ImmunizationFunctionCodes | ||||
| Immunization.performer:administrator.function | extensible | Pattern: AP | ||||
| Immunization.reasonCode | example | ImmunizationReasonCodes | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReason | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibility | ||||
| Immunization.fundingSource | example | ImmunizationFundingSource | ||||
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Immunization | This is an abstract profile. Child profiles: NlcoreVaccinationevent Vaccination | |
| status | 1..1 | code | completed | entered-in-error | not-done | |
| vaccineCode | 1..1 | CodeableConcept | ProductCode Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 (required) | |
| Slices for occurrence[x] | 1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this | |
| occurrence[x]:occurrenceDateTime | 1..1 | dateTime | VaccinationDate | |
| doseQuantity | 0..1 | SimpleQuantity | Dose Required Pattern: At least the following | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| Slices for performer | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:function | |
| performer:administrator | 0..1 | BackboneElement | Who performed event | |
| function | 1..1 | CodeableConcept | What type of performance was done Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor | 1..1 | PatternZibHealthProfessionalReference(Practitioner | PractitionerRole | Organization | zib HealthProfessional PractitionerRole) | Administrator | |
| note | 0..1 | Annotation | Additional immunization notes | |
| text | 1..1 | markdown | Comment | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Immunization.vaccineCode | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Immunization | This is an abstract profile. Child profiles: NlcoreVaccinationevent Vaccination | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
| vaccineCode | Σ | 1..1 | CodeableConcept | ProductCode Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 (required) |
| patient | Σ | 1..1 | Reference(Patient) | Who was immunized |
| Slices for occurrence[x] | Σ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
| occurrenceDateTime | dateTime | |||
| occurrenceString | string | |||
| occurrence[x]:occurrenceDateTime | Σ | 1..1 | dateTime | VaccinationDate |
| doseQuantity | 0..1 | SimpleQuantity | Dose Required Pattern: At least the following | |
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |
| Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:function |
| performer:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
| performer:administrator | Σ | 0..1 | BackboneElement | Who performed event |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | Σ | 1..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |
| actor | Σ | 1..1 | PatternZibHealthProfessionalReference(Practitioner | PractitionerRole | Organization | zib HealthProfessional PractitionerRole) | Administrator |
| note | Σ | 0..1 | Annotation | Additional immunization notes |
| text | Σ | 1..1 | markdown | Comment |
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Immunization.status | required | ImmunizationStatusCodes |
| Immunization.vaccineCode | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 |
| Immunization.performer:administrator.function | extensible | Pattern: AP |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | 0..* | Immunization | This is an abstract profile. Child profiles: NlcoreVaccinationevent Vaccination | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||
| statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | |||||
| vaccineCode | Σ | 1..1 | CodeableConcept | ProductCode Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 (required) | ||||
| patient | Σ | 1..1 | Reference(Patient) | Who was immunized | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| Slices for occurrence[x] | Σ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrenceString | string | |||||||
| occurrence[x]:occurrenceDateTime | Σ | 1..1 | dateTime | VaccinationDate | ||||
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
| reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
| location | 0..1 | Reference(Location) | Where immunization occurred | |||||
| manufacturer | 0..1 | Reference(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: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
| route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
| doseQuantity | 0..1 | SimpleQuantity | Dose Required Pattern: At least the following | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
| comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
| unit | 0..1 | string | Unit representation | |||||
| system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
| code | 0..1 | code | Coded form of the unit | |||||
| Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:function | ||||
| performer:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
| actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
| performer:administrator | Σ | 0..1 | BackboneElement | Who performed event | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 1..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| actor | Σ | 1..1 | PatternZibHealthProfessionalReference(Practitioner | PractitionerRole | Organization | zib HealthProfessional PractitionerRole) | Administrator | ||||
| note | Σ | 0..1 | Annotation | Additional immunization notes | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | Comment | ||||
| reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education | C | 0..* | BackboneElement | Educational material presented to patient | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| documentType | 0..1 | string | Educational material document identifier | |||||
| reference | 0..1 | uri | Educational material reference pointer | |||||
| publicationDate | 0..1 | dateTime | Educational material publication date | |||||
| presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
| programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
| fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
| reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| date | 0..1 | dateTime | When reaction started | |||||
| detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
| reported | 0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| series | 0..1 | string | Name of vaccine series | |||||
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
| targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
| doseNumber[x] | 1..1 | Dose number within series | ||||||
| doseNumberPositiveInt | positiveInt | |||||||
| doseNumberString | string | |||||||
| seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
| seriesDosesPositiveInt | positiveInt | |||||||
| seriesDosesString | string | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Immunization.language | preferred | CommonLanguages
| ||||
| Immunization.status | required | ImmunizationStatusCodes | ||||
| Immunization.statusReason | example | ImmunizationStatusReasonCodes | ||||
| Immunization.vaccineCode | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.17--20200901000000 | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodes | ||||
| Immunization.site | example | CodesForImmunizationSiteOfAdministration | ||||
| Immunization.route | example | ImmunizationRouteCodes | ||||
| Immunization.performer.function | extensible | ImmunizationFunctionCodes | ||||
| Immunization.performer:administrator.function | extensible | Pattern: AP | ||||
| Immunization.reasonCode | example | ImmunizationReasonCodes | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReason | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibility | ||||
| Immunization.fundingSource | example | ImmunizationFundingSource | ||||
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() |
This structure is derived from Immunization
Summary
Mandatory: 0 element (1 nested mandatory element)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron