0.1.0 - ci-build
NAPKONBIH - Local Development build (v0.1.0). See the Directory of published versions
Defining URL: | https://www.netzwerk-universitaetsmedizin.de/fhir/StructureDefinition/covid-vaccination |
Version: | 0.1.0 |
Name: | CovidVaccination |
Title: | Covid Vaccination |
Status: | Active as of 2021-10-19T22:00:24+00:00 |
Definition: | COVID-19 vaccination event |
Publisher: | BIH @ Charité |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://www.netzwerk-universitaetsmedizin.de/fhir/StructureDefinition/covid-vaccination
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Immunization | Immunization event information immunization-status-reason-if-not-done: If status is set to #not-done, a statusReason must be supplied |
![]() ![]() ![]() | 0..1 | CodeableConcept | Reason not done Binding: covid-vaccination-contraindications (required) | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Code defined by a terminology system Binding: CovidVaccinationCodes (required) | |
![]() ![]() ![]() | SI | 0..1 | string | Vaccine lot number must-exist-if-vaccination-performed: This item must be specified if the vaccination was performed |
![]() ![]() ![]() | SI | 1..1 | CodeableConcept | Why immunization occurred Binding: Covid Vaccination Reasons (required) codeable-concept-text-present-if-code-other: If codeableConcept.coding is set to SNOMED CT 'Other (qualifier value)', a string in codeableConcept.text must be supplied to identify the value of 'other' |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Vaccination Injection Site Pain Rest | Vaccination Injection Site Pain Movement | Vaccination Injection Site Erythema | Vaccination Injection Site Swelling | Body Temperature After Vaccination | Allergic Reaction To Vaccination) | Additional information on reaction | |
![]() ![]() ![]() | 1..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/900000000000207008/version/20210731 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 840539006 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system Fixed Value: Disease caused by Severe acute respiratory syndrome coronavirus 2 (disorder) | |
![]() ![]() ![]() ![]() | 1..1 | positiveInt | Dose number within series | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Immunization | Immunization event information immunization-status-reason-if-not-done: If status is set to #not-done, a statusReason must be supplied |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() | 0..* | Identifier | Business identifier | |
![]() ![]() ![]() | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | 0..1 | CodeableConcept | Reason not done Binding: covid-vaccination-contraindications (required) | |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: VaccinesSNOMED (extensible): SNOMED Vaccine Codes Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: VaccinesATC (extensible): ATC Vaccine Codes Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: PZN (required) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: Absent or Unknown Immunization - IPS (required) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Binding: CovidVaccinationCodes (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | SΣI | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() | I | 0..1 | Reference(Encounter) | Encounter immunization was part of |
![]() ![]() ![]() | SΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() | SΣ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | |
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() ![]() | 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. | |
![]() ![]() ![]() | I | 0..1 | Reference(Location) | Where immunization occurred |
![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Vaccine manufacturer |
![]() ![]() ![]() | SI | 0..1 | string | Vaccine lot number must-exist-if-vaccination-performed: This item must be specified if the vaccination was performed |
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Amount of vaccine administered |
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes |
![]() ![]() ![]() | SI | 1..1 | CodeableConcept | Why immunization occurred Binding: Covid Vaccination Reasons (required) codeable-concept-text-present-if-code-other: If codeableConcept.coding is set to SNOMED CT 'Other (qualifier value)', a string in codeableConcept.text must be supplied to identify the value of 'other' |
![]() ![]() ![]() | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |
![]() ![]() ![]() | I | 0..* | BackboneElement | Educational material presented to patient |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Educational material document identifier | |
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |
![]() ![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | dateTime | When reaction started | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Vaccination Injection Site Pain Rest | Vaccination Injection Site Pain Movement | Vaccination Injection Site Erythema | Vaccination Injection Site Swelling | Body Temperature After Vaccination | Allergic Reaction To Vaccination) | Additional information on reaction |
![]() ![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | |
![]() ![]() ![]() | S | 1..* | BackboneElement | Protocol followed by the provider |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Name of vaccine series | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |
![]() ![]() ![]() ![]() | S | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://fhir.kbv.de/ValueSet/KBV_VS_MIO_Vaccination_TargetDisease (extensible): The vaccine preventable disease the dose is being administered for. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/900000000000207008/version/20210731 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 840539006 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system Fixed Value: Disease caused by Severe acute respiratory syndrome coronavirus 2 (disorder) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 1..1 | positiveInt | Dose number within series Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | 1..1 | positiveInt | Dose number within series | |
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Immunization | Immunization event information immunization-status-reason-if-not-done: If status is set to #not-done, a statusReason must be supplied |
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system Binding: VaccinesSNOMED (extensible): SNOMED Vaccine Codes Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system Binding: VaccinesATC (extensible): ATC Vaccine Codes Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system Binding: PZN (required) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
![]() ![]() ![]() ![]() | Σ | 0..1 | Coding | Code defined by a terminology system Binding: Absent or Unknown Immunization - IPS (required) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips | |
![]() ![]() ![]() | ΣI | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() | Σ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() | I | 0..1 | string | Vaccine lot number must-exist-if-vaccination-performed: This item must be specified if the vaccination was performed |
![]() ![]() ![]() | I | 1..1 | CodeableConcept | Why immunization occurred Binding: Covid Vaccination Reasons (required) codeable-concept-text-present-if-code-other: If codeableConcept.coding is set to SNOMED CT 'Other (qualifier value)', a string in codeableConcept.text must be supplied to identify the value of 'other' |
![]() ![]() ![]() | 1..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://fhir.kbv.de/ValueSet/KBV_VS_MIO_Vaccination_TargetDisease (extensible): The vaccine preventable disease the dose is being administered for. Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/900000000000207008/version/20210731 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 840539006 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system Fixed Value: Disease caused by Severe acute respiratory syndrome coronavirus 2 (disorder) | |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | Coding | Code defined by a terminology system |
![]() |
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Immunization
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Immunization | Immunization event information immunization-status-reason-if-not-done: If status is set to #not-done, a statusReason must be supplied |
![]() ![]() ![]() | 0..1 | CodeableConcept | Reason not done Binding: covid-vaccination-contraindications (required) | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Code defined by a terminology system Binding: CovidVaccinationCodes (required) | |
![]() ![]() ![]() | SI | 0..1 | string | Vaccine lot number must-exist-if-vaccination-performed: This item must be specified if the vaccination was performed |
![]() ![]() ![]() | SI | 1..1 | CodeableConcept | Why immunization occurred Binding: Covid Vaccination Reasons (required) codeable-concept-text-present-if-code-other: If codeableConcept.coding is set to SNOMED CT 'Other (qualifier value)', a string in codeableConcept.text must be supplied to identify the value of 'other' |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..1 | Reference(Vaccination Injection Site Pain Rest | Vaccination Injection Site Pain Movement | Vaccination Injection Site Erythema | Vaccination Injection Site Swelling | Body Temperature After Vaccination | Allergic Reaction To Vaccination) | Additional information on reaction | |
![]() ![]() ![]() | 1..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() ![]() | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/900000000000207008/version/20210731 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 840539006 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system Fixed Value: Disease caused by Severe acute respiratory syndrome coronavirus 2 (disorder) | |
![]() ![]() ![]() ![]() | 1..1 | positiveInt | Dose number within series | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Immunization | Immunization event information immunization-status-reason-if-not-done: If status is set to #not-done, a statusReason must be supplied |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() | 0..* | Identifier | Business identifier | |
![]() ![]() ![]() | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. |
![]() ![]() ![]() | 0..1 | CodeableConcept | Reason not done Binding: covid-vaccination-contraindications (required) | |
![]() ![]() ![]() | SΣ | 1..1 | CodeableConcept | Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered. |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: VaccinesSNOMED (extensible): SNOMED Vaccine Codes Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: VaccinesATC (extensible): ATC Vaccine Codes Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/bfarm/atc | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: PZN (required) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.de/CodeSystem/ifa/pzn | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: Absent or Unknown Immunization - IPS (required) Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Binding: CovidVaccinationCodes (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() | SΣI | 1..1 | Reference(Patient) | Who was immunized |
![]() ![]() ![]() | I | 0..1 | Reference(Encounter) | Encounter immunization was part of |
![]() ![]() ![]() | SΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() ![]() | string | |||
![]() ![]() ![]() ![]() | SΣ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() | 0..1 | dateTime | When the immunization was first captured in the subject's record | |
![]() ![]() ![]() | Σ | 0..1 | boolean | Indicates context the data was recorded in |
![]() ![]() ![]() | 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. | |
![]() ![]() ![]() | I | 0..1 | Reference(Location) | Where immunization occurred |
![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Vaccine manufacturer |
![]() ![]() ![]() | SI | 0..1 | string | Vaccine lot number must-exist-if-vaccination-performed: This item must be specified if the vaccination was performed |
![]() ![]() ![]() | 0..1 | date | Vaccine expiration date | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |
![]() ![]() ![]() | I | 0..1 | SimpleQuantity | Amount of vaccine administered |
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing |
![]() ![]() ![]() | Σ | 0..* | Annotation | Additional immunization notes |
![]() ![]() ![]() | SI | 1..1 | CodeableConcept | Why immunization occurred Binding: Covid Vaccination Reasons (required) codeable-concept-text-present-if-code-other: If codeableConcept.coding is set to SNOMED CT 'Other (qualifier value)', a string in codeableConcept.text must be supplied to identify the value of 'other' |
![]() ![]() ![]() | I | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred |
![]() ![]() ![]() | ?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |
![]() ![]() ![]() | I | 0..* | BackboneElement | Educational material presented to patient |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Educational material document identifier | |
![]() ![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | |
![]() ![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | |
![]() ![]() ![]() | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |
![]() ![]() ![]() | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |
![]() ![]() ![]() | 0..* | BackboneElement | Details of a reaction that follows immunization | |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | dateTime | When reaction started | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Vaccination Injection Site Pain Rest | Vaccination Injection Site Pain Movement | Vaccination Injection Site Erythema | Vaccination Injection Site Swelling | Body Temperature After Vaccination | Allergic Reaction To Vaccination) | Additional information on reaction |
![]() ![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | |
![]() ![]() ![]() | S | 1..* | BackboneElement | Protocol followed by the provider |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | 0..1 | string | Name of vaccine series | |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations |
![]() ![]() ![]() ![]() | S | 1..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: https://fhir.kbv.de/ValueSet/KBV_VS_MIO_Vaccination_TargetDisease (extensible): The vaccine preventable disease the dose is being administered for. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Version of the system - if relevant Fixed Value: http://snomed.info/sct/900000000000207008/version/20210731 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 840539006 | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Representation defined by the system Fixed Value: Disease caused by Severe acute respiratory syndrome coronavirus 2 (disorder) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | SΣ | 1..1 | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version of the system - if relevant |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | string | Plain text representation of the concept |
![]() ![]() ![]() ![]() | 1..1 | positiveInt | Dose number within series Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() ![]() ![]() | 1..1 | positiveInt | Dose number within series | |
![]() ![]() ![]() ![]() | 0..1 | Recommended number of doses for immunity | ||
![]() ![]() ![]() ![]() ![]() | positiveInt | |||
![]() ![]() ![]() ![]() ![]() | string | |||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Immunization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Immunization.status | required | ImmunizationStatusCodes |
Immunization.statusReason | required | CovidVaccinationContraindications |
Immunization.vaccineCode | example | VaccineAdministeredValueSet |
Immunization.vaccineCode.coding:snomed | extensible | Pattern: SNOMED CT code null |
Immunization.vaccineCode.coding:atc | extensible | Pattern: null |
Immunization.vaccineCode.coding:pzn | required | Pattern: null |
Immunization.vaccineCode.coding:absentOrUnknownImmunization | required | Pattern: null |
Immunization.vaccineCode.coding:napkon | required | CovidVaccinationCodes |
Immunization.reportOrigin | example | ImmunizationOriginCodes |
Immunization.site | example | CodesForImmunizationSiteOfAdministration |
Immunization.route | example | ImmunizationRouteCodes |
Immunization.performer.function | extensible | ImmunizationFunctionCodes |
Immunization.reasonCode | required | CovidVaccinationReasons |
Immunization.subpotentReason | example | ImmunizationSubpotentReason |
Immunization.programEligibility | example | ImmunizationProgramEligibility |
Immunization.fundingSource | example | ImmunizationFundingSource |
Immunization.protocolApplied.targetDisease | extensible | Pattern: SNOMED CT code 840539006("Disease caused by Severe acute respiratory syndrome coronavirus 2 (disorder)") |
Id | Path | Details | Requirements |
dom-2 | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-4 | 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-3 | 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-6 | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
dom-5 | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
immunization-status-reason-if-not-done | Immunization | If status is set to #not-done, a statusReason must be supplied : (status = 'not-done') implies statusReason.exists() | |
ele-1 | Immunization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.vaccineCode.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.vaccineCode.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:snomed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:snomed.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.vaccineCode.coding:snomed.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.vaccineCode.coding:snomed.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:snomed.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:snomed.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:snomed.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:snomed.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:atc | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:atc.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.vaccineCode.coding:atc.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.vaccineCode.coding:atc.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:atc.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:atc.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:atc.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:atc.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:pzn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:pzn.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.vaccineCode.coding:pzn.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.vaccineCode.coding:pzn.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:pzn.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:pzn.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:pzn.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:pzn.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:absentOrUnknownImmunization.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.coding:napkon | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.vaccineCode.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.patient | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.encounter | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.occurrence[x]:occurrenceDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.recorded | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.primarySource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reportOrigin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.location | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.manufacturer | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
must-exist-if-vaccination-performed | Immunization.lotNumber | This item must be specified if the vaccination was performed : (status = 'completed') implies $this.exists() | |
ele-1 | Immunization.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.site | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.route | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.doseQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
qty-3 | Immunization.doseQuantity | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
sqty-1 | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity : comparator.empty() | |
ele-1 | Immunization.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.performer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.performer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.performer.function | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.performer.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.performer.actor | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
codeable-concept-text-present-if-code-other | Immunization.reasonCode | If codeableConcept.coding is set to SNOMED CT 'Other (qualifier value)', a string in codeableConcept.text must be supplied to identify the value of 'other' : (coding.system = 'http://snomed.info/sct' and coding.code = '74964007') implies text.exists() | |
ele-1 | Immunization.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.reasonReference | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.isSubpotent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.subpotentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
imm-1 | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
ele-1 | Immunization.education.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.education.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.education.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.education.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.education.documentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education.publicationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.education.presentationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.programEligibility | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.fundingSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.reaction.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.reaction.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.reaction.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.reaction.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.reaction.detail | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.reaction.reported | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.protocolApplied.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.protocolApplied.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.protocolApplied.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ref-1 | Immunization.protocolApplied.authority | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) | |
ele-1 | Immunization.protocolApplied.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.protocolApplied.targetDisease.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.protocolApplied.targetDisease.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.coding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Immunization.protocolApplied.targetDisease.coding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Immunization.protocolApplied.targetDisease.coding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.coding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.coding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.coding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.coding.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.targetDisease.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.doseNumber[x]:doseNumberPositiveInt | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |