SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU1

SMART Health Cards: Vaccination &amp; Testing Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. 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

## Resource Profile: Vaccination Profile - Data Minimization

Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-dm | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 4 | Computable Name: SHCVaccinationDM

Defines a primary (DM) profile representing a vaccination in a health card.

See here for implementation details.

↓ Start here!

Usages:

- Use this Profile: Vaccination Bundle - Data Minimization

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | SHCVaccinationAD | Immunization event information
meta | S Σ | 0..1 | Meta | Metadata about the resource
extension |  | 0..0 |  |
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 Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode | S Σ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
extension |  | 0..0 |  |
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx | S Σ | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
coding:snomed | S Σ | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: SNOMED CT vaccine codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:icd11 | S Σ | 0..1 | Coding | ICD-11 MMS code identifying the administered vaccine product Binding: All ICD-11 codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
patient | S Σ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized
reference | Σ C | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
occurrence[x] | S Σ C | 1..1 | dateTime | Vaccine administration date Constraints: vc-polymorphic-date-invariant
lotNumber | S C | 0..1 | string | String representing lot number like `0123L45A` Constraints: vc-should-be-under-20-chars, vc-should-not-include-string-lot
performer | S Σ | 0..1 | BackboneElement | Who performed event
actor | S Σ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration.
extension |  | 0..0 |  |
display | S Σ C | 1..1 | string | Short, human-readable text representation of the organization. Constraints: vc-should-be-under-30-chars
isSubpotent | ?!S Σ C | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise Constraints: vc-shall-be-true-if-populated-invariant
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.meta.security | required | IdentityAssuranceLevel `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level` From this IG
Immunization.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` From the FHIR Standard
Immunization.vaccineCode | example | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:cvx | required | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:snomed | required | SnomedVaccineCodes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/SnomedVaccineCodes` From this IG
Immunization.vaccineCode.coding:icd11 | required | ICD11Codes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/ICD11Codes` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vc-polymorphic-date-invariant | warning | Immunization.occurrence[x] | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : ($this as dateTime).toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') |
vc-shall-be-true-if-populated-invariant | error | Immunization.isSubpotent | Shall be `true` if populated : $this.exists().not() or $this = true |
vc-should-be-under-20-chars | warning | Immunization.lotNumber | Length SHOULD be <20 for data minimization. : $this.length() < 20 |
vc-should-be-under-30-chars | warning | Immunization.performer.actor.display | Length SHOULD be <30 for data minimization. : $this.length() < 30 |
vc-should-not-include-string-lot | warning | Immunization.lotNumber | lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not() |

This structure is derived from SHCVaccinationAD

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  |  | SHCVaccinationAD |
id |  | 0..0 |  |
meta |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 0..0 |  |
source |  | 0..0 |  |
profile |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 0..0 |  |
vaccineCode |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
Slices for coding |  |  |  | Content/Rules for all slices
coding:cvx |  | 0..1 | Coding | CVX code identifying the administered vaccine product
id |  | 0..0 |  |
extension |  | 0..0 |  |
version |  | 0..0 |  |
display |  | 0..0 |  |
userSelected |  | 0..0 |  |
coding:snomed |  | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product
id |  | 0..0 |  |
extension |  | 0..0 |  |
version |  | 0..0 |  |
display |  | 0..0 |  |
userSelected |  | 0..0 |  |
coding:icd11 |  | 0..1 | Coding | ICD-11 MMS code identifying the administered vaccine product
id |  | 0..0 |  |
extension |  | 0..0 |  |
version |  | 0..0 |  |
display |  | 0..0 |  |
userSelected |  | 0..0 |  |
text |  | 0..0 |  |
patient |  | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized
encounter |  | 0..0 |  |
recorded |  | 0..0 |  |
primarySource |  | 0..0 |  |
reportOrigin |  | 0..0 |  |
location |  | 0..0 |  |
manufacturer |  | 0..0 |  |
expirationDate |  | 0..0 |  |
site |  | 0..0 |  |
route |  | 0..0 |  |
doseQuantity |  | 0..0 |  |
performer |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
function |  | 0..0 |  |
actor |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
reference |  | 0..0 |  |
type |  | 0..0 |  |
identifier |  | 0..0 |  |
note |  | 0..0 |  |
reasonCode |  | 0..0 |  |
reasonReference |  | 0..0 |  |
subpotentReason |  | 0..0 |  |
education |  | 0..0 |  |
programEligibility |  | 0..0 |  |
fundingSource |  | 0..0 |  |
reaction |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | SHCVaccinationAD | Immunization event information
meta | S Σ | 0..1 | Meta | Metadata about the resource
extension |  | 0..0 |  |
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 Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode | S Σ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
extension |  | 0..0 |  |
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx | S Σ | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
code | Σ | 0..1 | code | Symbol in syntax defined by the system
coding:snomed | S Σ | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: SNOMED CT vaccine codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code | Σ | 0..1 | code | Symbol in syntax defined by the system
coding:icd11 | S Σ | 0..1 | Coding | ICD-11 MMS code identifying the administered vaccine product Binding: All ICD-11 codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
code | Σ | 0..1 | code | Symbol in syntax defined by the system
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 | Σ C | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
occurrence[x] | S Σ C | 1..1 | dateTime | Vaccine administration date Constraints: vc-polymorphic-date-invariant
lotNumber | S C | 0..1 | string | String representing lot number like `0123L45A` Constraints: vc-should-be-under-20-chars, vc-should-not-include-string-lot
performer | S Σ | 0..1 | BackboneElement | Who performed event
actor | S Σ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration.
extension |  | 0..0 |  |
display | S Σ C | 1..1 | string | Short, human-readable text representation of the organization. Constraints: vc-should-be-under-30-chars
isSubpotent | ?!S Σ C | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise Constraints: vc-shall-be-true-if-populated-invariant
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.meta.security | required | IdentityAssuranceLevel `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level` From this IG
Immunization.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` From the FHIR Standard
Immunization.vaccineCode | example | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:cvx | required | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:snomed | required | SnomedVaccineCodes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/SnomedVaccineCodes` From this IG
Immunization.vaccineCode.coding:icd11 | required | ICD11Codes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/ICD11Codes` From this IG
Immunization.manufacturer.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
Immunization.manufacturer.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Immunization.manufacturer.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes `http://hl7.org/fhir/ValueSet/immunization-target-disease` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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') |
vc-polymorphic-date-invariant | warning | Immunization.occurrence[x] | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : ($this as dateTime).toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') |
vc-shall-be-true-if-populated-invariant | error | Immunization.isSubpotent | Shall be `true` if populated : $this.exists().not() or $this = true |
vc-should-be-under-20-chars | warning | Immunization.lotNumber | Length SHOULD be <20 for data minimization. : $this.length() < 20 |
vc-should-be-under-30-chars | warning | Immunization.performer.actor.display | Length SHOULD be <30 for data minimization. : $this.length() < 30 |
vc-should-not-include-string-lot | warning | Immunization.lotNumber | lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not() |

This structure is derived from SHCVaccinationAD

Summary

Prohibited: 60 elements

Maturity: 4

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | SHCVaccinationAD | Immunization event information
meta | S Σ | 0..1 | Meta | Metadata about the resource
extension |  | 0..0 |  |
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 Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode | S Σ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
extension |  | 0..0 |  |
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx | S Σ | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
coding:snomed | S Σ | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: SNOMED CT vaccine codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:icd11 | S Σ | 0..1 | Coding | ICD-11 MMS code identifying the administered vaccine product Binding: All ICD-11 codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
patient | S Σ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized
reference | Σ C | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
occurrence[x] | S Σ C | 1..1 | dateTime | Vaccine administration date Constraints: vc-polymorphic-date-invariant
lotNumber | S C | 0..1 | string | String representing lot number like `0123L45A` Constraints: vc-should-be-under-20-chars, vc-should-not-include-string-lot
performer | S Σ | 0..1 | BackboneElement | Who performed event
actor | S Σ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration.
extension |  | 0..0 |  |
display | S Σ C | 1..1 | string | Short, human-readable text representation of the organization. Constraints: vc-should-be-under-30-chars
isSubpotent | ?!S Σ C | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise Constraints: vc-shall-be-true-if-populated-invariant
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.meta.security | required | IdentityAssuranceLevel `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level` From this IG
Immunization.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` From the FHIR Standard
Immunization.vaccineCode | example | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:cvx | required | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:snomed | required | SnomedVaccineCodes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/SnomedVaccineCodes` From this IG
Immunization.vaccineCode.coding:icd11 | required | ICD11Codes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/ICD11Codes` From this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
vc-polymorphic-date-invariant | warning | Immunization.occurrence[x] | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : ($this as dateTime).toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') |
vc-shall-be-true-if-populated-invariant | error | Immunization.isSubpotent | Shall be `true` if populated : $this.exists().not() or $this = true |
vc-should-be-under-20-chars | warning | Immunization.lotNumber | Length SHOULD be <20 for data minimization. : $this.length() < 20 |
vc-should-be-under-30-chars | warning | Immunization.performer.actor.display | Length SHOULD be <30 for data minimization. : $this.length() < 30 |
vc-should-not-include-string-lot | warning | Immunization.lotNumber | lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not() |

Differential View

This structure is derived from SHCVaccinationAD

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  |  | SHCVaccinationAD |
id |  | 0..0 |  |
meta |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
versionId |  | 0..0 |  |
lastUpdated |  | 0..0 |  |
source |  | 0..0 |  |
profile |  | 0..0 |  |
tag |  | 0..0 |  |
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
text |  | 0..0 |  |
contained |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
identifier |  | 0..0 |  |
vaccineCode |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
Slices for coding |  |  |  | Content/Rules for all slices
coding:cvx |  | 0..1 | Coding | CVX code identifying the administered vaccine product
id |  | 0..0 |  |
extension |  | 0..0 |  |
version |  | 0..0 |  |
display |  | 0..0 |  |
userSelected |  | 0..0 |  |
coding:snomed |  | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product
id |  | 0..0 |  |
extension |  | 0..0 |  |
version |  | 0..0 |  |
display |  | 0..0 |  |
userSelected |  | 0..0 |  |
coding:icd11 |  | 0..1 | Coding | ICD-11 MMS code identifying the administered vaccine product
id |  | 0..0 |  |
extension |  | 0..0 |  |
version |  | 0..0 |  |
display |  | 0..0 |  |
userSelected |  | 0..0 |  |
text |  | 0..0 |  |
patient |  | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized
encounter |  | 0..0 |  |
recorded |  | 0..0 |  |
primarySource |  | 0..0 |  |
reportOrigin |  | 0..0 |  |
location |  | 0..0 |  |
manufacturer |  | 0..0 |  |
expirationDate |  | 0..0 |  |
site |  | 0..0 |  |
route |  | 0..0 |  |
doseQuantity |  | 0..0 |  |
performer |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
modifierExtension |  | 0..0 |  |
function |  | 0..0 |  |
actor |  |  |  |
id |  | 0..0 |  |
extension |  | 0..0 |  |
reference |  | 0..0 |  |
type |  | 0..0 |  |
identifier |  | 0..0 |  |
note |  | 0..0 |  |
reasonCode |  | 0..0 |  |
reasonReference |  | 0..0 |  |
subpotentReason |  | 0..0 |  |
education |  | 0..0 |  |
programEligibility |  | 0..0 |  |
fundingSource |  | 0..0 |  |
reaction |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | SHCVaccinationAD | Immunization event information
meta | S Σ | 0..1 | Meta | Metadata about the resource
extension |  | 0..0 |  |
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 Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode | S Σ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
extension |  | 0..0 |  |
Slices for coding | S Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx | S Σ | 0..1 | Coding | CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
code | Σ | 0..1 | code | Symbol in syntax defined by the system
coding:snomed | S Σ | 0..1 | Coding | SNOMED CT code identifying the administered vaccine product Binding: SNOMED CT vaccine codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code | Σ | 0..1 | code | Symbol in syntax defined by the system
coding:icd11 | S Σ | 0..1 | Coding | ICD-11 MMS code identifying the administered vaccine product Binding: All ICD-11 codes (required)
extension |  | 0..0 |  |
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
code | Σ | 0..1 | code | Symbol in syntax defined by the system
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 | Σ C | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
occurrence[x] | S Σ C | 1..1 | dateTime | Vaccine administration date Constraints: vc-polymorphic-date-invariant
lotNumber | S C | 0..1 | string | String representing lot number like `0123L45A` Constraints: vc-should-be-under-20-chars, vc-should-not-include-string-lot
performer | S Σ | 0..1 | BackboneElement | Who performed event
actor | S Σ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration.
extension |  | 0..0 |  |
display | S Σ C | 1..1 | string | Short, human-readable text representation of the organization. Constraints: vc-should-be-under-30-chars
isSubpotent | ?!S Σ C | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise Constraints: vc-shall-be-true-if-populated-invariant
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Immunization.meta.security | required | IdentityAssuranceLevel `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level` From this IG
Immunization.status | required | Fixed Value: completed `http://hl7.org/fhir/ValueSet/immunization-status|4.0.1` From the FHIR Standard
Immunization.vaccineCode | example | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:cvx | required | ImmunizationAllCvxValueSet `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx` From this IG
Immunization.vaccineCode.coding:snomed | required | SnomedVaccineCodes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/SnomedVaccineCodes` From this IG
Immunization.vaccineCode.coding:icd11 | required | ICD11Codes `http://hl7.org/fhir/uv/shc-vaccination/ValueSet/ICD11Codes` From this IG
Immunization.manufacturer.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
Immunization.manufacturer.identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` From the FHIR Standard
Immunization.manufacturer.identifier.type | extensible | Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` From the FHIR Standard
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes `http://hl7.org/fhir/ValueSet/immunization-target-disease` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | error | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() |
dom-4 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() |
dom-5 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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') |
vc-polymorphic-date-invariant | warning | Immunization.occurrence[x] | All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : ($this as dateTime).toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$') |
vc-shall-be-true-if-populated-invariant | error | Immunization.isSubpotent | Shall be `true` if populated : $this.exists().not() or $this = true |
vc-should-be-under-20-chars | warning | Immunization.lotNumber | Length SHOULD be <20 for data minimization. : $this.length() < 20 |
vc-should-be-under-30-chars | warning | Immunization.performer.actor.display | Length SHOULD be <30 for data minimization. : $this.length() < 30 |
vc-should-not-include-string-lot | warning | Immunization.lotNumber | lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not() |

This structure is derived from SHCVaccinationAD

Summary

Prohibited: 60 elements

Maturity: 4

Other representations of profile: CSV, Excel, Schematron