Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id		0..1	id	Should not be populated
meta	S	0..1	Meta	Metadata about the resource
security	S	0..1	Coding	Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required)
status	S	1..1	code	Whether or not the vaccination was completed Fixed Value: completed
statusReason		0..0
vaccineCode	S	1..1	CodeableConcept	Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
Slices for coding	S	1..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx		0..1	Coding	CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
coding:snomed		0..1	Coding	SNOMED CT code identifying the administered vaccine product Binding: Immunization / All / SNOMED CT (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:icd11		0..1	Coding	ICD-11 MMS code identifying the administered vaccine product Binding: Immunization / All / ICD-11 (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
patient	S	1..1	Reference(Patient Profile - General - Allowable Data)	Who was immunized
reference		1..1	string	This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
type		0..0
identifier		0..0
display		0..0
occurrence[x]	SC	1..1	dateTime	Vaccine administration date vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
primarySource		0..1	boolean	Information in this record from person who administered vaccine?
manufacturer
identifier		0..1	Identifier	Only populate when vaccine type is not provided in vaccineCode
system	C	1..1	uri	Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
value		1..1	string	The value that is unique
lotNumber	SC	0..1	string	String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
performer	S	0..1	BackboneElement	Who performed event
actor	S	1..1	Reference(Organization)	Organization which was responsible for vaccine administration.
display	SC	1..1	string	Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
isSubpotent	SC	0..1	boolean	Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
protocolApplied		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.meta.security	required	IdentityAssuranceLevel http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level from this IG
Immunization.vaccineCode	example	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:cvx	required	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:snomed	required	ImmunizationAllSnomedValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-snomed
Immunization.vaccineCode.coding:icd11	required	ImmunizationAllIcd11ValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-icd11

Constraints

Id	Grade	Path(s)	Details	Requirements
shall-use-known-vaccine-manufacturer-code-system	error	Immunization.manufacturer.identifier.system	SHALL use a known code system for identifying vaccine manufacturers : $this.matches('http://hl7.org/fhir/sid/mvx') or $this.matches('https://www.gs1.org/gln')
vc-polymorphic-date-invariant	warning	Immunization.occurrence[x]	All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : ($this as dateTime).toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
vc-shall-be-true-if-populated-invariant	error	Immunization.isSubpotent	Shall be `true` if populated : $this.exists().not() or $this = true
vc-should-be-under-20-chars	warning	Immunization.lotNumber	Length SHOULD be <20 for data minimization. : $this.length() < 20
vc-should-be-under-30-chars	warning	Immunization.performer.actor.display	Length SHOULD be <30 for data minimization. : $this.length() < 30
vc-should-not-include-string-lot	warning	Immunization.lotNumber	lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not()

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Should not be populated
meta	SΣ	0..1	Meta	Metadata about the resource
security	SΣ	0..1	Coding	Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode	SΣ	1..1	CodeableConcept	Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx	Σ	0..1	Coding	CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
coding:snomed	Σ	0..1	Coding	SNOMED CT code identifying the administered vaccine product Binding: Immunization / All / SNOMED CT (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:icd11	Σ	0..1	Coding	ICD-11 MMS code identifying the administered vaccine product Binding: Immunization / All / ICD-11 (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
patient	SΣ	1..1	Reference(Patient Profile - General - Allowable Data)	Who was immunized
reference	ΣC	1..1	string	This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
primarySource	Σ	0..1	boolean	Information in this record from person who administered vaccine?
lotNumber	SC	0..1	string	String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
performer	SΣ	0..1	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Organization)	Organization which was responsible for vaccine administration.
display	SΣC	1..1	string	Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
isSubpotent	?!SΣC	0..1	boolean	Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
Documentation for this format

Terminology Bindings

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

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Should not be populated
meta	SΣ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	SΣ	0..1	Coding	Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode	SΣ	1..1	CodeableConcept	Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx	Σ	0..1	Coding	CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:snomed	Σ	0..1	Coding	SNOMED CT code identifying the administered vaccine product Binding: Immunization / All / SNOMED CT (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:icd11	Σ	0..1	Coding	ICD-11 MMS code identifying the administered vaccine product Binding: Immunization / All / ICD-11 (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Patient Profile - General - Allowable Data)	Who was immunized
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Information in this record from person who administered vaccine?
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Only populate when vaccine type is not provided in vaccineCode
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	ΣC	1..1	uri	Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
lotNumber	SC	0..1	string	String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Organization)	Organization which was responsible for vaccine administration.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣC	1..1	string	Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!SΣC	0..1	boolean	Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.meta.security	required	IdentityAssuranceLevel http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level from this IG
Immunization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	example	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:cvx	required	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:snomed	required	ImmunizationAllSnomedValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-snomed
Immunization.vaccineCode.coding:icd11	required	ImmunizationAllIcd11ValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-icd11
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.manufacturer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.manufacturer.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.manufacturer.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer.actor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

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

Summary

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

Structures

This structure refers to these other structures:

• Patient Profile - General - Allowable Data (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-general-ad)

Slices

This structure defines the following Slices:

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id		0..1	id	Should not be populated
meta	S	0..1	Meta	Metadata about the resource
security	S	0..1	Coding	Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required)
status	S	1..1	code	Whether or not the vaccination was completed Fixed Value: completed
statusReason		0..0
vaccineCode	S	1..1	CodeableConcept	Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
Slices for coding	S	1..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx		0..1	Coding	CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
coding:snomed		0..1	Coding	SNOMED CT code identifying the administered vaccine product Binding: Immunization / All / SNOMED CT (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:icd11		0..1	Coding	ICD-11 MMS code identifying the administered vaccine product Binding: Immunization / All / ICD-11 (required)
system		1..1	uri	Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
patient	S	1..1	Reference(Patient Profile - General - Allowable Data)	Who was immunized
reference		1..1	string	This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
type		0..0
identifier		0..0
display		0..0
occurrence[x]	SC	1..1	dateTime	Vaccine administration date vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
primarySource		0..1	boolean	Information in this record from person who administered vaccine?
manufacturer
identifier		0..1	Identifier	Only populate when vaccine type is not provided in vaccineCode
system	C	1..1	uri	Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
value		1..1	string	The value that is unique
lotNumber	SC	0..1	string	String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
performer	S	0..1	BackboneElement	Who performed event
actor	S	1..1	Reference(Organization)	Organization which was responsible for vaccine administration.
display	SC	1..1	string	Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
isSubpotent	SC	0..1	boolean	Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
protocolApplied		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.meta.security	required	IdentityAssuranceLevel http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level from this IG
Immunization.vaccineCode	example	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:cvx	required	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:snomed	required	ImmunizationAllSnomedValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-snomed
Immunization.vaccineCode.coding:icd11	required	ImmunizationAllIcd11ValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-icd11

Constraints

Id	Grade	Path(s)	Details	Requirements
shall-use-known-vaccine-manufacturer-code-system	error	Immunization.manufacturer.identifier.system	SHALL use a known code system for identifying vaccine manufacturers : $this.matches('http://hl7.org/fhir/sid/mvx') or $this.matches('https://www.gs1.org/gln')
vc-polymorphic-date-invariant	warning	Immunization.occurrence[x]	All timestamps SHOULD be represented as Dates (YYYY-MM-DD only). : ($this as dateTime).toString().matches('^[0-9]{4}-[0-9]{2}-[0-9]{2}$')
vc-shall-be-true-if-populated-invariant	error	Immunization.isSubpotent	Shall be `true` if populated : $this.exists().not() or $this = true
vc-should-be-under-20-chars	warning	Immunization.lotNumber	Length SHOULD be <20 for data minimization. : $this.length() < 20
vc-should-be-under-30-chars	warning	Immunization.performer.actor.display	Length SHOULD be <30 for data minimization. : $this.length() < 30
vc-should-not-include-string-lot	warning	Immunization.lotNumber	lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. : $this.lower().contains('lot').not()

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Should not be populated
meta	SΣ	0..1	Meta	Metadata about the resource
security	SΣ	0..1	Coding	Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required)
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode	SΣ	1..1	CodeableConcept	Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx	Σ	0..1	Coding	CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
coding:snomed	Σ	0..1	Coding	SNOMED CT code identifying the administered vaccine product Binding: Immunization / All / SNOMED CT (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
coding:icd11	Σ	0..1	Coding	ICD-11 MMS code identifying the administered vaccine product Binding: Immunization / All / ICD-11 (required)
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
patient	SΣ	1..1	Reference(Patient Profile - General - Allowable Data)	Who was immunized
reference	ΣC	1..1	string	This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
primarySource	Σ	0..1	boolean	Information in this record from person who administered vaccine?
lotNumber	SC	0..1	string	String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
performer	SΣ	0..1	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Organization)	Organization which was responsible for vaccine administration.
display	SΣC	1..1	string	Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
isSubpotent	?!SΣC	0..1	boolean	Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
Documentation for this format

Terminology Bindings

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

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Should not be populated
meta	SΣ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	SΣ	0..1	Coding	Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: Identity Assurance Level (required)
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	Whether or not the vaccination was completed Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed
vaccineCode	SΣ	1..1	CodeableConcept	Codes identifying the vaccine product administered Binding: Immunization / All / CVX (example)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	SΣ	1..*	Coding	Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:cvx	Σ	0..1	Coding	CVX code identifying the administered vaccine product Binding: Immunization / All / CVX (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/sid/cvx
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:snomed	Σ	0..1	Coding	SNOMED CT code identifying the administered vaccine product Binding: Immunization / All / SNOMED CT (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://snomed.info/sct
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:icd11	Σ	0..1	Coding	ICD-11 MMS code identifying the administered vaccine product Binding: Immunization / All / ICD-11 (required)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: http://id.who.int/icd/release/11/mms
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Patient Profile - General - Allowable Data)	Who was immunized
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Information in this record from person who administered vaccine?
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Only populate when vaccine type is not provided in vaccineCode
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	ΣC	1..1	uri	Code identifying vaccine manufacturer shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
lotNumber	SC	0..1	string	String representing lot number like `0123L45A` vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Organization)	Organization which was responsible for vaccine administration.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣC	1..1	string	Short, human-readable text representation of the organization. vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!SΣC	0..1	boolean	Set to `true` if dose is subpotent; omit otherwise vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.meta.security	required	IdentityAssuranceLevel http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level from this IG
Immunization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	Fixed Value: completed http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	example	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:cvx	required	ImmunizationAllCvxValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-cvx
Immunization.vaccineCode.coding:snomed	required	ImmunizationAllSnomedValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-snomed
Immunization.vaccineCode.coding:icd11	required	ImmunizationAllIcd11ValueSet https://terminology.smarthealth.cards/ValueSet/immunization-all-icd11
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.manufacturer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.manufacturer.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.manufacturer.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.performer.actor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

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

Summary

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

Structures

This structure refers to these other structures:

• Patient Profile - General - Allowable Data (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-general-ad)

Slices

This structure defines the following Slices:

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