SMART Health Cards: Vaccination & Testing Implementation Guide
0.6.2 - STU 1 (Ballot Version)

SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 0.6.2). This version is based on the current content of https://github.com/HL7/fhir-shc-vaccination-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Vaccination Profile - Allowable Data

Defining URL:http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad
Version:0.6.2
Name:SHCVaccinationAD
Title:Vaccination Profile - Allowable Data
Status:Active as of 2021-08-11T19:30:57+00:00
Definition:

Defines a profile representing a vaccination for a SMART Health Card.

Publisher:HL7 International - Public Health Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad
Vaccination: Profile Group Navigation

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

Implementation instructions Start here!

Primary profile (DM) Fallback Profiles (AD) Scope
Vaccination Fallback Any infectious disease
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.

Formal Views of Profile Content

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

This structure is derived from Immunization

Summary

Mandatory: 3 elements (9 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode.coding is sliced based on the value of value:system (Closed)
  • The element Immunization.occurrence[x] is sliced based on the value of type:$this

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id 0..1stringShould not be populated
... meta
.... 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
Required Pattern: completed
... vaccineCode S1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Vaccine: 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: Vaccine: CVX (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/sid/cvx
..... coding:gtin 0..1CodingGTIN code identifying the administered vaccine product
Binding: Vaccine: GTIN (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://www.gs1.org/gtin
..... coding:snomed 0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Vaccine: SNOMED CT (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
..... coding:icd11 0..1CodingICD11 code identifying the administered vaccine product
Binding: Vaccine: ICD-11 (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://id.who.int/icd/release/11/mms
..... coding:air 0..1CodingAustralian Immunisation Register Vaccine code identifying the administered vaccine product
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
..... coding:atc 0..1CodingATC code identifying the administered vaccine product
Binding: Vaccine: ATC/DDD (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
... 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
... Slices for occurrence[x] S1..1dateTimeVaccine administration date
Slice: Unordered, Open by type:$this
... occurrenceDateTime SI1..1dateTimeVaccine administration date
vc-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 S0..1Reference(Organization)Vaccine manufacturer
.... identifier S0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... system SI1..1uriCode identifying vaccine manufacturer
shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
..... value S1..1stringThe value that is unique
... lotNumber SI0..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 SI1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent SI0..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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1stringShould not be populated
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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)
Max Binding: AllLanguages: A human language.

... 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.


Required Pattern: completed
... vaccineCode SΣ1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Vaccine: CVX (example)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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: Vaccine: CVX (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: 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:gtin Σ0..1CodingGTIN code identifying the administered vaccine product
Binding: Vaccine: GTIN (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.gs1.org/gtin
...... 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: Vaccine: SNOMED CT (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: 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..1CodingICD11 code identifying the administered vaccine product
Binding: Vaccine: ICD-11 (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: 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
..... coding:air Σ0..1CodingAustralian Immunisation Register Vaccine code identifying the administered vaccine product
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... 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:atc Σ0..1CodingATC code identifying the administered vaccine product
Binding: Vaccine: ATC/DDD (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
...... 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
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..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
... Slices for occurrence[x] SΣ1..1dateTimeVaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣI1..1dateTimeVaccine administration date
vc-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 S0..1Reference(Organization)Vaccine manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..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 SΣ0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... id 0..1stringUnique id for inter-element referencing
..... Slices for 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 SΣI1..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 SΣ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 SI0..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
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..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ΣI1..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ΣI0..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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... meta Σ0..1MetaMetadata about the resource
.... security Σ0..1CodingLimited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... status ?!Σ1..1codeWhether or not the vaccination was completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.


Required Pattern: completed
... vaccineCode Σ1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Vaccine: CVX (example)
.... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Closed by value:system
... Slices for occurrence[x] Σ1..1dateTimeVaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime ΣI1..1dateTimeVaccine administration date
vc-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
.... identifier Σ0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... system ΣI1..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 I0..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 Σ0..1BackboneElementWho performed event
.... actor Σ1..1Reference(Organization)Organization which was responsible for vaccine administration.
..... display ΣI1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent ?!ΣI0..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

This structure is derived from Immunization

Summary

Mandatory: 3 elements (9 nested mandatory elements)
Must-Support: 16 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Immunization.vaccineCode.coding is sliced based on the value of value:system (Closed)
  • The element Immunization.occurrence[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id 0..1stringShould not be populated
... meta
.... 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
Required Pattern: completed
... vaccineCode S1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Vaccine: 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: Vaccine: CVX (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://hl7.org/fhir/sid/cvx
..... coding:gtin 0..1CodingGTIN code identifying the administered vaccine product
Binding: Vaccine: GTIN (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://www.gs1.org/gtin
..... coding:snomed 0..1CodingSNOMED CT code identifying the administered vaccine product
Binding: Vaccine: SNOMED CT (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
..... coding:icd11 0..1CodingICD11 code identifying the administered vaccine product
Binding: Vaccine: ICD-11 (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://id.who.int/icd/release/11/mms
..... coding:air 0..1CodingAustralian Immunisation Register Vaccine code identifying the administered vaccine product
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
..... coding:atc 0..1CodingATC code identifying the administered vaccine product
Binding: Vaccine: ATC/DDD (required)
...... system 1..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
... 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
... Slices for occurrence[x] S1..1dateTimeVaccine administration date
Slice: Unordered, Open by type:$this
... occurrenceDateTime SI1..1dateTimeVaccine administration date
vc-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 S0..1Reference(Organization)Vaccine manufacturer
.... identifier S0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... system SI1..1uriCode identifying vaccine manufacturer
shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
..... value S1..1stringThe value that is unique
... lotNumber SI0..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 SI1..1stringShort, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
... isSubpotent SI0..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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationImmunization event information
... id Σ0..1stringShould not be populated
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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)
Max Binding: AllLanguages: A human language.

... 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.


Required Pattern: completed
... vaccineCode SΣ1..1CodeableConceptCodes identifying the vaccine product administered
Binding: Vaccine: CVX (example)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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: Vaccine: CVX (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: 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:gtin Σ0..1CodingGTIN code identifying the administered vaccine product
Binding: Vaccine: GTIN (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.gs1.org/gtin
...... 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: Vaccine: SNOMED CT (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: 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..1CodingICD11 code identifying the administered vaccine product
Binding: Vaccine: ICD-11 (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: 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
..... coding:air Σ0..1CodingAustralian Immunisation Register Vaccine code identifying the administered vaccine product
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats
...... 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:atc Σ0..1CodingATC code identifying the administered vaccine product
Binding: Vaccine: ATC/DDD (required)
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Required Pattern: http://www.whocc.no/atc
...... 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
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI1..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
... Slices for occurrence[x] SΣ1..1dateTimeVaccine administration date
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceDateTime SΣI1..1dateTimeVaccine administration date
vc-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 S0..1Reference(Organization)Vaccine manufacturer
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..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 SΣ0..1IdentifierOnly populate when vaccine type is not provided in vaccineCode
..... id 0..1stringUnique id for inter-element referencing
..... Slices for 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 SΣI1..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 SΣ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 SI0..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
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣI0..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ΣI1..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ΣI0..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 I0..*BackboneElementEducational material presented to patient
imm-1: One of documentType or reference SHALL be present
.... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Immunization.meta.securityrequiredIdentityAssuranceLevel
Immunization.meta.tagexampleCommonTags
Immunization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Immunization.statusrequiredPattern: completed
Immunization.vaccineCodeexampleVaccineCVX
Immunization.vaccineCode.coding:cvxrequiredVaccineCVX
Immunization.vaccineCode.coding:gtinrequiredVaccineGTIN
Immunization.vaccineCode.coding:snomedrequiredVaccineSNOMED
Immunization.vaccineCode.coding:icd11requiredVaccineICD11
Immunization.vaccineCode.coding:airrequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1
Immunization.vaccineCode.coding:atcrequiredVaccineATC
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

IdPathDetailsRequirements
dom-2ImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ImmunizationIf 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-4ImmunizationIf 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-5ImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1Immunization.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.meta.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.meta.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.meta.versionIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.meta.lastUpdatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.meta.sourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.meta.profileAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.meta.securityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.meta.tagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:cvxAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:cvx.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.coding:cvx.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.coding:cvx.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:cvx.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:cvx.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:cvx.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:cvx.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:gtinAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:gtin.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.coding:gtin.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.coding:gtin.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:gtin.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:gtin.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:gtin.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:gtin.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:snomedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:snomed.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.coding:snomed.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.coding:snomed.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:snomed.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:snomed.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:snomed.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:snomed.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:icd11All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:icd11.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.coding:icd11.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.coding:icd11.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:icd11.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:icd11.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:icd11.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:icd11.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:airAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:air.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.coding:air.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.coding:air.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:air.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:air.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:air.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:air.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:atcAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:atc.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.vaccineCode.coding:atc.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.vaccineCode.coding:atc.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:atc.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:atc.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:atc.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.coding:atc.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.vaccineCode.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.patient.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.occurrence[x]:occurrenceDateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-date-invariantImmunization.occurrence[x]:occurrenceDateTimeAll timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
: $this.toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
ele-1Immunization.recordedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.primarySourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reportOriginAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.manufacturer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.manufacturer.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.manufacturer.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.manufacturer.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
shall-use-known-vaccine-manufacturer-code-systemImmunization.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')
ele-1Immunization.manufacturer.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.manufacturer.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.lotNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-under-20-charsImmunization.lotNumberLength SHOULD be <20 for data minimization.
: $this.length() < 20
vc-should-not-include-string-lotImmunization.lotNumberlotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
: $this.lower().contains('lot').not()
ele-1Immunization.expirationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.siteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.routeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.doseQuantityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.functionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actor.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.performer.actor.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.performer.actor.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actor.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actor.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.performer.actor.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-should-be-under-30-charsImmunization.performer.actor.displayLength SHOULD be <30 for data minimization.
: $this.length() < 30
ele-1Immunization.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.isSubpotentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-shall-be-true-if-populated-invariantImmunization.isSubpotentShall be `true` if populated
: $this.exists().not() or $this = true
ele-1Immunization.subpotentReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.educationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
imm-1Immunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()
ele-1Immunization.education.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.education.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.education.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.education.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.education.documentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.publicationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.education.presentationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.programEligibilityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.fundingSourceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reactionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.reaction.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.reaction.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.reaction.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.reaction.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.detailAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.reaction.reportedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.protocolApplied.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.protocolApplied.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Immunization.protocolApplied.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Immunization.protocolApplied.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.targetDiseaseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.doseNumber[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Immunization.protocolApplied.seriesDoses[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())