SMART Health Cards: Vaccination & Testing Implementation Guide
0.6.2 - STU 1 (Ballot Version)
SMART Health Cards: Vaccination & Testing Implementation Guide
0.6.2 - STU 1 (Ballot Version)
SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 0.6.2). This version is based on the current content of https://github.com/HL7/fhir-shc-vaccination-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad | Version: 0.6.2 | |||
| Active as of 2022-06-27 | Computable Name: SHCVaccinationAD | |||
Defines a profile representing a vaccination for a SMART Health Card.
For representing a vaccination for an infectious disease such as COVID-19 or influenza.
Implementation instructions ← Start here!
| Primary profile (DM) | Fallback Profiles (AD) | Scope |
|---|---|---|
| Vaccination | Fallback | Any infectious disease |
Note! This is a fallback “allowable data” (AD) profile. Implementers should validate against the primary “data minimization” (DM) profile if possible.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Summary
Mandatory: 3 elements (9 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization | 0..* | Immunization | Immunization event information | |
  id | 0..1 | string | Should not be populated | |
 meta | ||||
  security | S | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
| status | S | 1..1 | code | Whether or not the vaccination was completed Required Pattern: completed |
| statusReason | 0..0 | |||
| vaccineCode | S | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Vaccine: CVX (example) |
  Slices for coding | S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system |
   coding:cvx | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Vaccine: CVX (required) | |
  system | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/sid/cvx | |
| coding:gtin | 0..1 | Coding | GTIN code identifying the administered vaccine product Binding: Vaccine: GTIN (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.gs1.org/gtin | |
| coding:snomed | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: Vaccine: SNOMED CT (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
| coding:icd11 | 0..1 | Coding | ICD11 code identifying the administered vaccine product Binding: Vaccine: ICD-11 (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://id.who.int/icd/release/11/mms | |
| coding:air | 0..1 | Coding | Australian Immunisation Register Vaccine code identifying the administered vaccine product Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
 coding:atc | 0..1 | Coding | ATC code identifying the administered vaccine product Binding: Vaccine: ATC/DDD (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://www.whocc.no/atc | |
 patient | S | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized |
| reference | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | |
| type | 0..0 | |||
| identifier | 0..0 | |||
| display | 0..0 | |||
| occurrence[x] | S | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this |
 occurrenceDateTime | SI | 1..1 | dateTime | Vaccine administration date vc-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). |
| primarySource | 0..1 | boolean | Information in this record from person who administered vaccine? | |
| manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer |
| identifier | S | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode |
| system | SI | 1..1 | uri | Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers |
| value | S | 1..1 | string | The value that is unique |
| lotNumber | SI | 0..1 | string | String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. |
| performer | S | 0..1 | BackboneElement | Who performed event |
| actor | S | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. |
| display | SI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
| isSubpotent | SI | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated |
| protocolApplied | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | 0..* | Immunization | Immunization event information | |||||
| id | Σ | 0..1 | string | Should not be populated | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | ?!SΣ | 1..1 | code | Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed | ||||
| vaccineCode | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Vaccine: CVX (example) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system | ||||
| coding:cvx | Σ | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Vaccine: CVX (required) | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/sid/cvx | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:gtin | Σ | 0..1 | Coding | GTIN code identifying the administered vaccine product Binding: Vaccine: GTIN (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.gs1.org/gtin | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:snomed | Σ | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: Vaccine: SNOMED CT (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:icd11 | Σ | 0..1 | Coding | ICD11 code identifying the administered vaccine product Binding: Vaccine: ICD-11 (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://id.who.int/icd/release/11/mms | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:air | Σ | 0..1 | Coding | Australian Immunisation Register Vaccine code identifying the administered vaccine product Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:atc | Σ | 0..1 | Coding | ATC code identifying the administered vaccine product Binding: Vaccine: ATC/DDD (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://www.whocc.no/atc | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| 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 | ||||
| patient | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣI | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| Slices for occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
 occurrence[x]:occurrenceDateTime | SΣI | 1..1 | dateTime | Vaccine administration date vc-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). | ||||
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource | Σ | 0..1 | boolean | Information in this record from person who administered vaccine? | ||||
| 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 | S | 0..1 | Reference(Organization) | Vaccine manufacturer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | SΣ | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣI | 1..1 | uri | Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| lotNumber | SI | 0..1 | string | String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. | ||||
| 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 | Amount of vaccine administered | |||||
| performer | SΣ | 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 | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
| actor | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | SΣI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. | ||||
| note | Σ | 0..* | Annotation | Additional immunization notes | ||||
| 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 | ?!SΣI | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated | ||||
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education | I | 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 | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | 0..* | Immunization | Immunization event information | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| security | Σ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
| status | ?!Σ | 1..1 | code | Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed |
| vaccineCode | Σ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Vaccine: CVX (example) |
| coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system |
| patient | Σ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized |
| Slices for occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this |
| occurrence[x]:occurrenceDateTime | ΣI | 1..1 | dateTime | Vaccine administration date vc-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). |
| manufacturer | 0..1 | Reference(Organization) | Vaccine manufacturer | |
| identifier | Σ | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode |
| system | ΣI | 1..1 | uri | Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers |
| value | Σ | 1..1 | string | The value that is unique |
| lotNumber | I | 0..1 | string | String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. |
| performer | Σ | 0..1 | BackboneElement | Who performed event |
| actor | Σ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. |
| display | ΣI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
| isSubpotent | ?!ΣI | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated |
| Documentation for this format | ||||
This structure is derived from Immunization
Summary
Mandatory: 3 elements (9 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 5 elements
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 | Immunization event information | |
| id | 0..1 | string | Should not be populated | |
| meta | ||||
| security | S | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) |
| status | S | 1..1 | code | Whether or not the vaccination was completed Required Pattern: completed |
| statusReason | 0..0 | |||
| vaccineCode | S | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Vaccine: CVX (example) |
| Slices for coding | S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system |
| coding:cvx | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Vaccine: CVX (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/sid/cvx | |
| coding:gtin | 0..1 | Coding | GTIN code identifying the administered vaccine product Binding: Vaccine: GTIN (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.gs1.org/gtin | |
| coding:snomed | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: Vaccine: SNOMED CT (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | |
| coding:icd11 | 0..1 | Coding | ICD11 code identifying the administered vaccine product Binding: Vaccine: ICD-11 (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://id.who.int/icd/release/11/mms | |
| coding:air | 0..1 | Coding | Australian Immunisation Register Vaccine code identifying the administered vaccine product Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | |
| coding:atc | 0..1 | Coding | ATC code identifying the administered vaccine product Binding: Vaccine: ATC/DDD (required) | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://www.whocc.no/atc | |
| patient | S | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized |
| reference | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | |
| type | 0..0 | |||
| identifier | 0..0 | |||
| display | 0..0 | |||
| occurrence[x] | S | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Open by type:$this |
| occurrenceDateTime | SI | 1..1 | dateTime | Vaccine administration date vc-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). |
| primarySource | 0..1 | boolean | Information in this record from person who administered vaccine? | |
| manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer |
| identifier | S | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode |
| system | SI | 1..1 | uri | Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers |
| value | S | 1..1 | string | The value that is unique |
| lotNumber | SI | 0..1 | string | String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. |
| performer | S | 0..1 | BackboneElement | Who performed event |
| actor | S | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. |
| display | SI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. |
| isSubpotent | SI | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated |
| protocolApplied | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | 0..* | Immunization | Immunization event information | |||||
| id | Σ | 0..1 | string | Should not be populated | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required) | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | ?!SΣ | 1..1 | code | Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed | ||||
| vaccineCode | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Vaccine: CVX (example) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding | SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system | ||||
| coding:cvx | Σ | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Vaccine: CVX (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://hl7.org/fhir/sid/cvx | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:gtin | Σ | 0..1 | Coding | GTIN code identifying the administered vaccine product Binding: Vaccine: GTIN (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.gs1.org/gtin | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:snomed | Σ | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: Vaccine: SNOMED CT (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:icd11 | Σ | 0..1 | Coding | ICD11 code identifying the administered vaccine product Binding: Vaccine: ICD-11 (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://id.who.int/icd/release/11/mms | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:air | Σ | 0..1 | Coding | Australian Immunisation Register Vaccine code identifying the administered vaccine product Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| coding:atc | Σ | 0..1 | Coding | ATC code identifying the administered vaccine product Binding: Vaccine: ATC/DDD (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://www.whocc.no/atc | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| 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 | ||||
| patient | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣI | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| Slices for occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceDateTime | SΣI | 1..1 | dateTime | Vaccine administration date vc-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). | ||||
| recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
| primarySource | Σ | 0..1 | boolean | Information in this record from person who administered vaccine? | ||||
| 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 | S | 0..1 | Reference(Organization) | Vaccine manufacturer | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | SΣ | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | SΣI | 1..1 | uri | Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| lotNumber | SI | 0..1 | string | String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. | ||||
| 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 | Amount of vaccine administered | |||||
| performer | SΣ | 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 | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
| actor | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | SΣI | 1..1 | string | Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. | ||||
| note | Σ | 0..* | Annotation | Additional immunization notes | ||||
| 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 | ?!SΣI | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated | ||||
| subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
| education | I | 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 | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| Immunization.meta.security | required | IdentityAssuranceLevel |
| Immunization.meta.tag | example | CommonTags |
| Immunization.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Immunization.status | required | Pattern: completed |
| Immunization.vaccineCode | example | VaccineCVX |
| Immunization.vaccineCode.coding:cvx | required | VaccineCVX |
| Immunization.vaccineCode.coding:gtin | required | VaccineGTIN |
| Immunization.vaccineCode.coding:snomed | required | VaccineSNOMED |
| Immunization.vaccineCode.coding:icd11 | required | VaccineICD11 |
| Immunization.vaccineCode.coding:air | required | https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 |
| Immunization.vaccineCode.coding:atc | required | VaccineATC |
| Immunization.reportOrigin | example | ImmunizationOriginCodes |
| Immunization.manufacturer.type | extensible | ResourceType |
| Immunization.manufacturer.identifier.use | required | IdentifierUse |
| Immunization.manufacturer.identifier.type | extensible | Identifier Type Codes |
| Immunization.site | example | CodesForImmunizationSiteOfAdministration |
| Immunization.route | example | ImmunizationRouteCodes |
| Immunization.performer.function | extensible | ImmunizationFunctionCodes |
| Immunization.performer.actor.type | extensible | ResourceType |
| Immunization.reasonCode | example | ImmunizationReasonCodes |
| Immunization.subpotentReason | example | ImmunizationSubpotentReason |
| Immunization.programEligibility | example | ImmunizationProgramEligibility |
| Immunization.fundingSource | example | ImmunizationFundingSource |
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
| Id | Grade | Path | 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 | Immunization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.meta.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.meta.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.meta.versionId | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.meta.lastUpdated | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.meta.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.meta.profile | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.meta.security | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.meta.tag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.coding:cvx.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:cvx.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.coding:gtin.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:gtin.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.coding:snomed.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:snomed.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11 | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.coding:icd11.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:icd11.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:air | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:air.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.coding:air.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding:air.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:air.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:air.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:air.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:air.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:atc | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:atc.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.vaccineCode.coding:atc.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.vaccineCode.coding:atc.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:atc.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:atc.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:atc.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.coding:atc.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.vaccineCode.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.patient.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.occurrence[x]:occurrenceDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| vc-date-invariant | warning | Immunization.occurrence[x]:occurrenceDateTime | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') | |
| ele-1 | error | Immunization.recorded | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.primarySource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reportOrigin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.manufacturer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.manufacturer.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.manufacturer.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.manufacturer.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| shall-use-known-vaccine-manufacturer-code-system | error | Immunization.manufacturer.identifier.system | SHALL use a known code system for identifying vaccine manufacturers : $this.matches('http://hl7.org/fhir/sid/mvx') or $this.matches('https://www.gs1.org/gln') | |
| ele-1 | error | Immunization.manufacturer.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.manufacturer.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| vc-should-be-under-20-chars | warning | Immunization.lotNumber | Length SHOULD be <20 for data minimization. : $this.length() < 20 | |
| vc-should-not-include-string-lot | warning | Immunization.lotNumber | lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not() | |
| ele-1 | error | Immunization.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.site | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.route | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.doseQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.performer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.performer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.performer.function | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer.actor.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.performer.actor.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.performer.actor.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer.actor.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer.actor.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.performer.actor.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| vc-should-be-under-30-chars | warning | Immunization.performer.actor.display | Length SHOULD be <30 for data minimization. : $this.length() < 30 | |
| ele-1 | error | Immunization.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.isSubpotent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| vc-shall-be-true-if-populated-invariant | error | Immunization.isSubpotent | Shall be `true` if populated : $this.exists().not() or $this = true | |
| ele-1 | error | Immunization.subpotentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.education | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
| ele-1 | error | Immunization.education.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.education.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.education.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.education.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.education.documentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.education.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.education.publicationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.education.presentationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.programEligibility | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.fundingSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reaction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.reaction.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.reaction.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.reaction.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reaction.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.reaction.reported | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.protocolApplied.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.protocolApplied.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.protocolApplied.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Immunization.protocolApplied.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.protocolApplied.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.protocolApplied.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.protocolApplied.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2021+ HL7 International - Public Health Work Group. Package hl7.fhir.uv.shc-vaccination#0.6.2 based on FHIR 4.0.1. Generated 2022-06-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change