SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU1 Release 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 - Allowable Data

Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad Version: 1.0.0
Draft as of 2023-12-27 Computable Name: SHCVaccinationAD

Defines a fallback (AD) 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.

Note! This is a fallback “allowable data” (AD) profile. Implementers should validate against the primary “data minimization” (DM) profile if possible.

Usage:

Formal Views of Profile Content

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

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id 0..1idShould not be populated
... meta S0..1MetaMetadata about the resource
.... security S0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... status S1..1codeWhether or not the vaccination was completed
Fixed Value: completed
... vaccineCode S1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Immunization / All / CVX (example)
.... Slices for coding S1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
..... coding:cvx 0..1CodingCVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/cvx
..... coding:snomed 0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:icd11 0..1CodingICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
... patient S1..1Reference(Patient Profile - General - Allowable Data)Who was immunized
.... reference 1..1stringThis 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] SC1..1dateTimeVaccine administration date
vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... primarySource 0..1booleanInformation in this record from person who administered vaccine?
... manufacturer
.... identifier 0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... system C1..1uriCode identifying vaccine manufacturer
shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
..... value 1..1stringThe value that is unique
... lotNumber SC0..1stringString 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 S0..1BackboneElementWho performed event
.... actor S1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... display SC1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent SC0..1booleanSet to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
... protocolApplied 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.vaccineCodeexampleImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:cvxrequiredImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:snomedrequiredImmunizationAllSnomedValueSet
Immunization.vaccineCode.coding:icd11requiredImmunizationAllIcd11ValueSet

Constraints

IdGradePath(s)DetailsRequirements
shall-use-known-vaccine-manufacturer-code-systemerrorImmunization.manufacturer.identifier.systemSHALL 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-invariantwarningImmunization.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-invarianterrorImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
vc-should-be-under-20-charswarningImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-be-under-30-charswarningImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
vc-should-not-include-string-lotwarningImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1idShould not be populated
... meta SΣ0..1MetaMetadata about the resource
.... security SΣ0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... status ?!SΣ1..1codeWhether 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..1CodeableConceptCodes identifying the vaccine product administered
Binding: Immunization / All / CVX (example)
.... Slices for coding SΣ1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
..... coding:cvx Σ0..1CodingCVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/cvx
..... coding:snomed Σ0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:icd11 Σ0..1CodingICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
... patient SΣ1..1Reference(Patient Profile - General - Allowable Data)Who was immunized
.... reference ΣC1..1stringThis SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... occurrence[x] SΣC1..1dateTimeVaccine administration date
vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... primarySource Σ0..1booleanInformation in this record from person who administered vaccine?
... lotNumber SC0..1stringString 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..1BackboneElementWho performed event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor SΣ1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... display SΣC1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent ?!SΣC0..1booleanSet to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.statusrequiredFixed Value: completed
Immunization.vaccineCodeexampleImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:cvxrequiredImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:snomedrequiredImmunizationAllSnomedValueSet
Immunization.vaccineCode.coding:icd11requiredImmunizationAllIcd11ValueSet

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vc-polymorphic-date-invariantwarningImmunization.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-invarianterrorImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
vc-should-be-under-20-charswarningImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-be-under-30-charswarningImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
vc-should-not-include-string-lotwarningImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1idShould not be populated
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣ0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codeWhether 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..1CodeableConceptCodes identifying the vaccine product administered
Binding: Immunization / All / CVX (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
..... coding:cvx Σ0..1CodingCVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/cvx
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:snomed Σ0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:icd11 Σ0..1CodingICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(Patient Profile - General - Allowable Data)Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringThis SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣC1..1dateTimeVaccine administration date
vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanInformation in this record from person who administered vaccine?
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 ΣC1..1uriCode 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 Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... display Σ0..1stringText alternative for the resource
... lotNumber SC0..1stringString 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..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..1BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor SΣ1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display SΣC1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!SΣC0..1booleanSet to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.meta.tagexampleCommonTags
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredFixed Value: completed
Immunization.vaccineCodeexampleImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:cvxrequiredImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:snomedrequiredImmunizationAllSnomedValueSet
Immunization.vaccineCode.coding:icd11requiredImmunizationAllIcd11ValueSet
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.manufacturer.typeextensibleResourceType
Immunization.manufacturer.identifier.userequiredIdentifierUse
Immunization.manufacturer.identifier.typeextensibleIdentifier Type Codes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.performer.actor.typeextensibleResourceType
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
shall-use-known-vaccine-manufacturer-code-systemerrorImmunization.manufacturer.identifier.systemSHALL 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-invariantwarningImmunization.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-invarianterrorImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
vc-should-be-under-20-charswarningImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-be-under-30-charswarningImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
vc-should-not-include-string-lotwarningImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()

This structure is derived from Immunization

Summary

Mandatory: 2 elements (6 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 4 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode.coding is sliced based on the value of value:system (Closed)

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id 0..1idShould not be populated
... meta S0..1MetaMetadata about the resource
.... security S0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... status S1..1codeWhether or not the vaccination was completed
Fixed Value: completed
... vaccineCode S1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Immunization / All / CVX (example)
.... Slices for coding S1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
..... coding:cvx 0..1CodingCVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/cvx
..... coding:snomed 0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:icd11 0..1CodingICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
... patient S1..1Reference(Patient Profile - General - Allowable Data)Who was immunized
.... reference 1..1stringThis 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] SC1..1dateTimeVaccine administration date
vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... primarySource 0..1booleanInformation in this record from person who administered vaccine?
... manufacturer
.... identifier 0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... system C1..1uriCode identifying vaccine manufacturer
shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
..... value 1..1stringThe value that is unique
... lotNumber SC0..1stringString 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 S0..1BackboneElementWho performed event
.... actor S1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... display SC1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent SC0..1booleanSet to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
... protocolApplied 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.vaccineCodeexampleImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:cvxrequiredImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:snomedrequiredImmunizationAllSnomedValueSet
Immunization.vaccineCode.coding:icd11requiredImmunizationAllIcd11ValueSet

Constraints

IdGradePath(s)DetailsRequirements
shall-use-known-vaccine-manufacturer-code-systemerrorImmunization.manufacturer.identifier.systemSHALL 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-invariantwarningImmunization.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-invarianterrorImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
vc-should-be-under-20-charswarningImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-be-under-30-charswarningImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
vc-should-not-include-string-lotwarningImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1idShould not be populated
... meta SΣ0..1MetaMetadata about the resource
.... security SΣ0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... status ?!SΣ1..1codeWhether 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..1CodeableConceptCodes identifying the vaccine product administered
Binding: Immunization / All / CVX (example)
.... Slices for coding SΣ1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
..... coding:cvx Σ0..1CodingCVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/cvx
..... coding:snomed Σ0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... coding:icd11 Σ0..1CodingICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 (required)
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
... patient SΣ1..1Reference(Patient Profile - General - Allowable Data)Who was immunized
.... reference ΣC1..1stringThis SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... occurrence[x] SΣC1..1dateTimeVaccine administration date
vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... primarySource Σ0..1booleanInformation in this record from person who administered vaccine?
... lotNumber SC0..1stringString 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..1BackboneElementWho performed event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... actor SΣ1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... display SΣC1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent ?!SΣC0..1booleanSet to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.statusrequiredFixed Value: completed
Immunization.vaccineCodeexampleImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:cvxrequiredImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:snomedrequiredImmunizationAllSnomedValueSet
Immunization.vaccineCode.coding:icd11requiredImmunizationAllIcd11ValueSet

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vc-polymorphic-date-invariantwarningImmunization.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-invarianterrorImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
vc-should-be-under-20-charswarningImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-be-under-30-charswarningImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
vc-should-not-include-string-lotwarningImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1idShould not be populated
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security SΣ0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codeWhether 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..1CodeableConceptCodes identifying the vaccine product administered
Binding: Immunization / All / CVX (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
..... coding:cvx Σ0..1CodingCVX code identifying the administered vaccine product
Binding: Immunization / All / CVX (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/sid/cvx
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:snomed Σ0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:icd11 Σ0..1CodingICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://id.who.int/icd/release/11/mms
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... patient SΣ1..1Reference(Patient Profile - General - Allowable Data)Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringThis SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣC1..1dateTimeVaccine administration date
vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanInformation in this record from person who administered vaccine?
... reportOrigin 0..1CodeableConceptIndicates 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..1Reference(Location)Where immunization occurred
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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 ΣC1..1uriCode 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 Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... display Σ0..1stringText alternative for the resource
... lotNumber SC0..1stringString 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..1dateVaccine expiration date
... site 0..1CodeableConceptBody site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

... route 0..1CodeableConceptHow vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.

... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..1BackboneElementWho performed event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor SΣ1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
..... display SΣC1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!SΣC0..1booleanSet to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows immunization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.meta.tagexampleCommonTags
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredFixed Value: completed
Immunization.vaccineCodeexampleImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:cvxrequiredImmunizationAllCvxValueSet
Immunization.vaccineCode.coding:snomedrequiredImmunizationAllSnomedValueSet
Immunization.vaccineCode.coding:icd11requiredImmunizationAllIcd11ValueSet
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.manufacturer.typeextensibleResourceType
Immunization.manufacturer.identifier.userequiredIdentifierUse
Immunization.manufacturer.identifier.typeextensibleIdentifier Type Codes
Immunization.siteexampleCodesForImmunizationSiteOfAdministration
Immunization.routeexampleImmunizationRouteCodes
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.performer.actor.typeextensibleResourceType
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
shall-use-known-vaccine-manufacturer-code-systemerrorImmunization.manufacturer.identifier.systemSHALL 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-invariantwarningImmunization.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-invarianterrorImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
vc-should-be-under-20-charswarningImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-be-under-30-charswarningImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
vc-should-not-include-string-lotwarningImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()

This structure is derived from Immunization

Summary

Mandatory: 2 elements (6 nested mandatory elements)
Must-Support: 12 elements
Fixed Value: 4 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode.coding is sliced based on the value of value:system (Closed)

 

Other representations of profile: CSV, Excel, Schematron