haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: haau3 Immunization

A vaccination recorded about a care recipient. Delivered exactly as the source system stated it, including dose-protocol details; the occurrence may arrive as a date or as the source's own free-text form.

Usages:

• Examples for this Profile: Immunization/haau3-immunization-protocol-applied

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	USCoreImmunizationProfile(6.1.0)	Immunization event information Constraints: us-core-5
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier	S This element must be supported.	1..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	(USCDI) completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
Immunization.statusReason	S This element must be supported.	0..1	CodeableConcept	(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (example)
Immunization.vaccineCode	S This element must be supported. Σ This element is included in summaries. C	1..1	CodeableConcept	(USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible)
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(US Core Patient Profile)	(USCDI) Who was immunized
Immunization.occurrence[x]	S This element must be supported. Σ This element is included in summaries.	1..1		(USCDI) Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime S This target must be supported.
Immunization.occurrence[x].occurrenceString			string
Immunization.primarySource	S This element must be supported. Σ This element is included in summaries.	0..1	boolean	(USCDI) Indicates context the data was recorded in
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📦4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦4.0.1	FHIR Std.
Immunization.vaccineCode	Base	extensible	CVX Vaccines Administered Vaccine Set	📦20220701	VSAC v0.11

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
us-core-5	best practice	Immunization	SHOULD have a translation to the NDC value set	vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty()

This structure is derived from USCoreImmunizationProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	USCoreImmunizationProfile(6.1.0)	Immunization event information
Immunization.identifier	S This element must be supported.	1..*	Identifier	Business identifier
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	USCoreImmunizationProfile(6.1.0)	Immunization event information Constraints: us-core-5
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Immunization.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained		0..*	Resource	Contained, inline Resources
Immunization.extension		0..*	Extension	Additional content defined by implementations
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier	S This element must be supported.	1..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	(USCDI) completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
Immunization.statusReason	S This element must be supported.	0..1	CodeableConcept	(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (example)
Immunization.vaccineCode	S This element must be supported. Σ This element is included in summaries. C	1..1	CodeableConcept	(USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible)
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(US Core Patient Profile)	(USCDI) Who was immunized
Immunization.encounter		0..1	Reference(Encounter)	Encounter immunization was part of
Immunization.occurrence[x]	S This element must be supported. Σ This element is included in summaries.	1..1		(USCDI) Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime S This target must be supported.
Immunization.occurrence[x].occurrenceString			string
Immunization.recorded		0..1	dateTime	When the immunization was first captured in the subject's record
Immunization.primarySource	S This element must be supported. Σ This element is included in summaries.	0..1	boolean	(USCDI) Indicates context the data was recorded in
Immunization.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.
Immunization.location		0..1	Reference(Location)	Where immunization occurred
Immunization.manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number
Immunization.expirationDate		0..1	date	Vaccine expiration date
Immunization.site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity	C	0..1	SimpleQuantity	Amount of vaccine administered Constraints: sqty-1
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.performer.id		0..1	string	Unique id for inter-element referencing
Immunization.performer.extension		0..*	Extension	Additional content defined by implementations
Immunization.performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes
Immunization.reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Immunization.subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
Immunization.education.id		0..1	string	Unique id for inter-element referencing
Immunization.education.extension		0..*	Extension	Additional content defined by implementations
Immunization.education.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType		0..1	string	Educational material document identifier
Immunization.education.reference		0..1	uri	Educational material reference pointer
Immunization.education.publicationDate		0..1	dateTime	Educational material publication date
Immunization.education.presentationDate		0..1	dateTime	Educational material presentation date
Immunization.programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	Unique id for inter-element referencing
Immunization.reaction.extension		0..*	Extension	Additional content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction
Immunization.protocolApplied		0..*	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.id		0..1	string	Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..*	Extension	Additional content defined by implementations
Immunization.protocolApplied.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series		0..1	string	Name of vaccine series
Immunization.protocolApplied.authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x]		1..1		Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt			positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString			string
Immunization.protocolApplied.seriesDoses[x]		0..1		Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt			positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📦4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦4.0.1	FHIR Std.
Immunization.vaccineCode	Base	extensible	CVX Vaccines Administered Vaccine Set	📦20220701	VSAC v0.11
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📦4.0.1	FHIR Std.
Immunization.site	Base	example	Codes for Immunization Site of Administration	📦4.0.1	FHIR Std.
Immunization.route	Base	example	Immunization Route Codes	📦4.0.1	FHIR Std.
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📦4.0.1	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📦4.0.1	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📦4.0.1	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📦4.0.1	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📦4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	example	Immunization Target Disease Codes	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present	documentType.exists() or reference.exists()
sqty-1	error	Immunization.doseQuantity	The comparator is not used on a SimpleQuantity	comparator.empty()
us-core-5	best practice	Immunization	SHOULD have a translation to the NDC value set	vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty()

This structure is derived from USCoreImmunizationProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	USCoreImmunizationProfile(6.1.0)	Immunization event information Constraints: us-core-5
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier	S This element must be supported.	1..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	(USCDI) completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
Immunization.statusReason	S This element must be supported.	0..1	CodeableConcept	(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (example)
Immunization.vaccineCode	S This element must be supported. Σ This element is included in summaries. C	1..1	CodeableConcept	(USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible)
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(US Core Patient Profile)	(USCDI) Who was immunized
Immunization.occurrence[x]	S This element must be supported. Σ This element is included in summaries.	1..1		(USCDI) Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime S This target must be supported.
Immunization.occurrence[x].occurrenceString			string
Immunization.primarySource	S This element must be supported. Σ This element is included in summaries.	0..1	boolean	(USCDI) Indicates context the data was recorded in
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📦4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦4.0.1	FHIR Std.
Immunization.vaccineCode	Base	extensible	CVX Vaccines Administered Vaccine Set	📦20220701	VSAC v0.11

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
us-core-5	best practice	Immunization	SHOULD have a translation to the NDC value set	vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty()

Differential View

This structure is derived from USCoreImmunizationProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	USCoreImmunizationProfile(6.1.0)	Immunization event information
Immunization.identifier	S This element must be supported.	1..*	Identifier	Business identifier
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	USCoreImmunizationProfile(6.1.0)	Immunization event information Constraints: us-core-5
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Immunization.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained		0..*	Resource	Contained, inline Resources
Immunization.extension		0..*	Extension	Additional content defined by implementations
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier	S This element must be supported.	1..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	(USCDI) completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
Immunization.statusReason	S This element must be supported.	0..1	CodeableConcept	(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (example)
Immunization.vaccineCode	S This element must be supported. Σ This element is included in summaries. C	1..1	CodeableConcept	(USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible)
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(US Core Patient Profile)	(USCDI) Who was immunized
Immunization.encounter		0..1	Reference(Encounter)	Encounter immunization was part of
Immunization.occurrence[x]	S This element must be supported. Σ This element is included in summaries.	1..1		(USCDI) Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime S This target must be supported.
Immunization.occurrence[x].occurrenceString			string
Immunization.recorded		0..1	dateTime	When the immunization was first captured in the subject's record
Immunization.primarySource	S This element must be supported. Σ This element is included in summaries.	0..1	boolean	(USCDI) Indicates context the data was recorded in
Immunization.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.
Immunization.location		0..1	Reference(Location)	Where immunization occurred
Immunization.manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number
Immunization.expirationDate		0..1	date	Vaccine expiration date
Immunization.site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity	C	0..1	SimpleQuantity	Amount of vaccine administered Constraints: sqty-1
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.performer.id		0..1	string	Unique id for inter-element referencing
Immunization.performer.extension		0..*	Extension	Additional content defined by implementations
Immunization.performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes
Immunization.reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Immunization.subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
Immunization.education.id		0..1	string	Unique id for inter-element referencing
Immunization.education.extension		0..*	Extension	Additional content defined by implementations
Immunization.education.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType		0..1	string	Educational material document identifier
Immunization.education.reference		0..1	uri	Educational material reference pointer
Immunization.education.publicationDate		0..1	dateTime	Educational material publication date
Immunization.education.presentationDate		0..1	dateTime	Educational material presentation date
Immunization.programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	Unique id for inter-element referencing
Immunization.reaction.extension		0..*	Extension	Additional content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction
Immunization.protocolApplied		0..*	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.id		0..1	string	Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..*	Extension	Additional content defined by implementations
Immunization.protocolApplied.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series		0..1	string	Name of vaccine series
Immunization.protocolApplied.authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x]		1..1		Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt			positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString			string
Immunization.protocolApplied.seriesDoses[x]		0..1		Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt			positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📦4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦4.0.1	FHIR Std.
Immunization.vaccineCode	Base	extensible	CVX Vaccines Administered Vaccine Set	📦20220701	VSAC v0.11
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📦4.0.1	FHIR Std.
Immunization.site	Base	example	Codes for Immunization Site of Administration	📦4.0.1	FHIR Std.
Immunization.route	Base	example	Immunization Route Codes	📦4.0.1	FHIR Std.
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📦4.0.1	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📦4.0.1	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📦4.0.1	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📦4.0.1	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📦4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	example	Immunization Target Disease Codes	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management	text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both	extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present	documentType.exists() or reference.exists()
sqty-1	error	Immunization.doseQuantity	The comparator is not used on a SimpleQuantity	comparator.empty()
us-core-5	best practice	Immunization	SHOULD have a translation to the NDC value set	vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty()

This structure is derived from USCoreImmunizationProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Other representations of profile: CSV, Excel, Schematron