SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU 1 International flag

SMART Health Cards: Vaccination & 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!
Profile Group: Vaccination

Description:

For representing a vaccination for an infectious disease such as COVID-19 or influenza.

Primary profile (DM) Fallback profile (AD) Scope of profile pair
Vaccination Fallback Any infectious disease
For more information about the types of profiles in this IG, see the profiles page.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* SHCVaccinationAD Immunization event information
... meta SΣ 0..1 Meta Metadata about the resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... 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 Extension
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 SΣ 0..1 Coding CVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
.... 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 SC 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 Extension
Slice: Unordered, Open by value:url
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:cvx Base required Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:snomed Base required SNOMED CT vaccine codes 📦1.0.0 This IG
Immunization.vaccineCode.​coding:icd11 Base required All ICD-11 codes 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization SHCVaccinationAD
... id 0..0 Should not be populated
... meta
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... versionId 0..0 Version specific identifier
.... lastUpdated 0..0 When the resource version last changed
.... source 0..0 Identifies where the resource comes from
.... profile 0..0 Profiles this resource claims to conform to
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... language 0..0 Language of the resource content
... text 0..0 Text summary of the resource, for human interpretation
... contained 0..0 Contained, inline Resources
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... identifier 0..0 Business identifier
... vaccineCode
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... Slices for coding Content/Rules for all slices
..... coding:cvx 0..1 Coding CVX code identifying the administered vaccine product
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... version 0..0 Version of the system - if relevant
...... display 0..0 Representation defined by the system
...... userSelected 0..0 If this coding was chosen directly by the user
..... coding:snomed 0..1 Coding SNOMED CT code identifying the administered vaccine product
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... version 0..0 Version of the system - if relevant
...... display 0..0 Representation defined by the system
...... userSelected 0..0 If this coding was chosen directly by the user
..... coding:icd11 0..1 Coding ICD-11 MMS code identifying the administered vaccine product
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... version 0..0 Version of the system - if relevant
...... display 0..0 Representation defined by the system
...... userSelected 0..0 If this coding was chosen directly by the user
.... text 0..0 Plain text representation of the concept
... patient 1..1 Reference(Patient Profile - General - Allowable Data) Who was immunized
... encounter 0..0 Encounter immunization was part of
... recorded 0..0 When the immunization was first captured in the subject's record
... primarySource 0..0 Information in this record from person who administered vaccine?
... reportOrigin 0..0 Indicates the source of a secondarily reported record
... location 0..0 Where immunization occurred
... manufacturer 0..0 Vaccine manufacturer
... expirationDate 0..0 Vaccine expiration date
... site 0..0 Body site vaccine was administered
... route 0..0 How vaccine entered body
... doseQuantity 0..0 Amount of vaccine administered
... performer
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... modifierExtension 0..0 Extension
.... function 0..0 What type of performance was done
.... actor
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... reference 0..0 Literal reference, Relative, internal or absolute URL
..... type 0..0 Type the reference refers to (e.g. "Patient")
..... identifier 0..0 Logical reference, when literal reference is not known
... note 0..0 Additional immunization notes
... reasonCode 0..0 Why immunization occurred
... reasonReference 0..0 Why immunization occurred
... subpotentReason 0..0 Reason for being subpotent
... education 0..0 Educational material presented to patient
... programEligibility 0..0 Patient eligibility for a vaccination program
... fundingSource 0..0 Funding source for the vaccine
... reaction 0..0 Details of a reaction that follows immunization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* SHCVaccinationAD Immunization event information
... meta SΣ 0..1 Meta Metadata about the resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... 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 Extension
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 SΣ 0..1 Coding CVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... 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
.... 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 SC 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 Extension
Slice: Unordered, Open by value:url
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:cvx Base required Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:snomed Base required SNOMED CT vaccine codes 📦1.0.0 This IG
Immunization.vaccineCode.​coding:icd11 Base required All ICD-11 codes 📦1.0.0 This IG
Immunization.manufacturer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Immunization.manufacturer.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Immunization.manufacturer.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* SHCVaccinationAD Immunization event information
... meta SΣ 0..1 Meta Metadata about the resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... 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 Extension
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 SΣ 0..1 Coding CVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
.... 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 SC 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 Extension
Slice: Unordered, Open by value:url
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:cvx Base required Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:snomed Base required SNOMED CT vaccine codes 📦1.0.0 This IG
Immunization.vaccineCode.​coding:icd11 Base required All ICD-11 codes 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization SHCVaccinationAD
... id 0..0 Should not be populated
... meta
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... versionId 0..0 Version specific identifier
.... lastUpdated 0..0 When the resource version last changed
.... source 0..0 Identifies where the resource comes from
.... profile 0..0 Profiles this resource claims to conform to
.... tag 0..0 Tags applied to this resource
... implicitRules 0..0 A set of rules under which this content was created
... language 0..0 Language of the resource content
... text 0..0 Text summary of the resource, for human interpretation
... contained 0..0 Contained, inline Resources
... extension 0..0 Extension
... modifierExtension 0..0 Extension
... identifier 0..0 Business identifier
... vaccineCode
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... Slices for coding Content/Rules for all slices
..... coding:cvx 0..1 Coding CVX code identifying the administered vaccine product
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... version 0..0 Version of the system - if relevant
...... display 0..0 Representation defined by the system
...... userSelected 0..0 If this coding was chosen directly by the user
..... coding:snomed 0..1 Coding SNOMED CT code identifying the administered vaccine product
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... version 0..0 Version of the system - if relevant
...... display 0..0 Representation defined by the system
...... userSelected 0..0 If this coding was chosen directly by the user
..... coding:icd11 0..1 Coding ICD-11 MMS code identifying the administered vaccine product
...... id 0..0 Unique id for inter-element referencing
...... extension 0..0 Extension
...... version 0..0 Version of the system - if relevant
...... display 0..0 Representation defined by the system
...... userSelected 0..0 If this coding was chosen directly by the user
.... text 0..0 Plain text representation of the concept
... patient 1..1 Reference(Patient Profile - General - Allowable Data) Who was immunized
... encounter 0..0 Encounter immunization was part of
... recorded 0..0 When the immunization was first captured in the subject's record
... primarySource 0..0 Information in this record from person who administered vaccine?
... reportOrigin 0..0 Indicates the source of a secondarily reported record
... location 0..0 Where immunization occurred
... manufacturer 0..0 Vaccine manufacturer
... expirationDate 0..0 Vaccine expiration date
... site 0..0 Body site vaccine was administered
... route 0..0 How vaccine entered body
... doseQuantity 0..0 Amount of vaccine administered
... performer
.... id 0..0 Unique id for inter-element referencing
.... extension 0..0 Extension
.... modifierExtension 0..0 Extension
.... function 0..0 What type of performance was done
.... actor
..... id 0..0 Unique id for inter-element referencing
..... extension 0..0 Extension
..... reference 0..0 Literal reference, Relative, internal or absolute URL
..... type 0..0 Type the reference refers to (e.g. "Patient")
..... identifier 0..0 Logical reference, when literal reference is not known
... note 0..0 Additional immunization notes
... reasonCode 0..0 Why immunization occurred
... reasonReference 0..0 Why immunization occurred
... subpotentReason 0..0 Reason for being subpotent
... education 0..0 Educational material presented to patient
... programEligibility 0..0 Patient eligibility for a vaccination program
... fundingSource 0..0 Funding source for the vaccine
... reaction 0..0 Details of a reaction that follows immunization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* SHCVaccinationAD Immunization event information
... meta SΣ 0..1 Meta Metadata about the resource
.... extension 0..0 Extension
Slice: Unordered, Open by value:url
.... 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 Extension
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 SΣ 0..1 Coding CVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... extension 0..0 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... 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 Extension
Slice: Unordered, Open by value:url
...... 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
.... 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 SC 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 Extension
Slice: Unordered, Open by value:url
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:cvx Base required Immunization / All / CVX 📦1.0.0 This IG
Immunization.vaccineCode.​coding:snomed Base required SNOMED CT vaccine codes 📦1.0.0 This IG
Immunization.vaccineCode.​coding:icd11 Base required All ICD-11 codes 📦1.0.0 This IG
Immunization.manufacturer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Immunization.manufacturer.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Immunization.manufacturer.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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