Kenya Patient Summary FHIR IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Immunization Profile - KPS

This profile defines constraints on the Immunization resource for use within the Kenya Patient Summary. It captures details of vaccines administered to a patient, supporting immunization history tracking, clinical decision-making, and data exchange within the national Health Information Exchange (HIE).

Usages:

• CapabilityStatements using this Profile: Kenya Patient Summary (KPS) FHIR IG Capability Statement
• This Profile is not used by any profiles in this Implementation Guide

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		0..*	ImmunizationUvIps	Immunization event information
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	Status of Vaccine Binding: Vaccine Status ValueSet (required)
vaccineCode	S	1..1	CodeableConceptIPS	Vaccine Code Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets
patient	SΣ	1..1	Reference(Patient Profile - KPS)	The Age of the Patient
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
occurrence[x]	SΣ	1..1	dateTime	Date of Immunization
Slices for extension				Content/Rules for all slices
extension:data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
location	S	0..1	Reference(Location)	Location of Immunization
lotNumber	S	0..1	string	Lot Number of Vaccine
performer	Σ	0..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Performer of Immunization
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	1..1	string	Name of Vaccine Series
targetDisease	S	1..1	CodeableConcept	Target Disease of Immunization Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate
doseNumber[x]	S	1..1	positiveInt	Dose Number in Series
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Vaccine Status ValueSet	📦0.1.0	This IG
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
Immunization.protocolApplied.​targetDisease	Base	preferred	Vaccine Target Diseases - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1

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()

This structure is derived from ImmunizationUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationUvIps	Immunization event information
status		1..1	code	Status of Vaccine Binding: Vaccine Status ValueSet (required)
vaccineCode		1..1	CodeableConceptIPS	Vaccine Code
patient		1..1	Reference(Patient Profile - KPS)	The Age of the Patient
occurrence[x]		1..1	dateTime	Date of Immunization
location	S	0..1	Reference(Location)	Location of Immunization
lotNumber	S	0..1	string	Lot Number of Vaccine
performer
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Performer of Immunization
protocolApplied
series	S	1..1	string	Name of Vaccine Series
targetDisease	S	1..1	CodeableConcept	Target Disease of Immunization
doseNumber[x]	S	1..1	positiveInt	Dose Number in Series
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Vaccine Status ValueSet	📦0.1.0	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationUvIps	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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	Status of Vaccine Binding: Vaccine Status ValueSet (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	S	1..1	CodeableConceptIPS	Vaccine Code Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets
patient	SΣ	1..1	Reference(Patient Profile - KPS)	The Age of the Patient
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	SΣC	1..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	Σ	0..1	string	Text alternative for the resource
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1	dateTime	Date of Immunization
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
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	S	0..1	Reference(Location)	Location of Immunization
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber	S	0..1	string	Lot Number of Vaccine
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	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(Practitioner | PractitionerRole | Organization)	Performer of Immunization
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	?!Σ	0..1	boolean	Dose potency
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 Constraints: imm-1
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
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
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
series	S	1..1	string	Name of Vaccine Series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	S	1..1	CodeableConcept	Target Disease of Immunization Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate
doseNumber[x]	S	1..1	positiveInt	Dose Number in Series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
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	Vaccine Status ValueSet	📦0.1.0	This IG
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦4.0.1	FHIR Std.
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
Immunization.patient.​type	Base	extensible	ResourceType	📦4.0.1	FHIR Std.
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📦4.0.1	FHIR Std.
Immunization.site	Base	preferred	SNOMED CT Body Structures	📦4.0.1	FHIR Std.
Immunization.route	Base	preferred	Medicine Route of Administration - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
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	preferred	Vaccine Target Diseases - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1

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()

This structure is derived from ImmunizationUvIps

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• Patient Profile - KPS (https://example.org/fhir/StructureDefinition/kps-patient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationUvIps	Immunization event information
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	Status of Vaccine Binding: Vaccine Status ValueSet (required)
vaccineCode	S	1..1	CodeableConceptIPS	Vaccine Code Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets
patient	SΣ	1..1	Reference(Patient Profile - KPS)	The Age of the Patient
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
occurrence[x]	SΣ	1..1	dateTime	Date of Immunization
Slices for extension				Content/Rules for all slices
extension:data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
location	S	0..1	Reference(Location)	Location of Immunization
lotNumber	S	0..1	string	Lot Number of Vaccine
performer	Σ	0..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Performer of Immunization
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series	S	1..1	string	Name of Vaccine Series
targetDisease	S	1..1	CodeableConcept	Target Disease of Immunization Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate
doseNumber[x]	S	1..1	positiveInt	Dose Number in Series
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Vaccine Status ValueSet	📦0.1.0	This IG
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
Immunization.protocolApplied.​targetDisease	Base	preferred	Vaccine Target Diseases - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1

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()

Differential View

This structure is derived from ImmunizationUvIps

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationUvIps	Immunization event information
status		1..1	code	Status of Vaccine Binding: Vaccine Status ValueSet (required)
vaccineCode		1..1	CodeableConceptIPS	Vaccine Code
patient		1..1	Reference(Patient Profile - KPS)	The Age of the Patient
occurrence[x]		1..1	dateTime	Date of Immunization
location	S	0..1	Reference(Location)	Location of Immunization
lotNumber	S	0..1	string	Lot Number of Vaccine
performer
actor	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Performer of Immunization
protocolApplied
series	S	1..1	string	Name of Vaccine Series
targetDisease	S	1..1	CodeableConcept	Target Disease of Immunization
doseNumber[x]	S	1..1	positiveInt	Dose Number in Series
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Vaccine Status ValueSet	📦0.1.0	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	ImmunizationUvIps	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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	Status of Vaccine Binding: Vaccine Status ValueSet (required)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	S	1..1	CodeableConceptIPS	Vaccine Code Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Additional Bindings Purpose Documentation Vaccines - SNOMED CT IPS Free Set candidate For when codes from the SNOMED CT IPS free set are preferred Vaccines WHO ATC - IPS candidate For when WHO ATC code system is preferred Absent or Unknown Immunization - IPS candidate "known absent" and "not known", for use with other value sets
patient	SΣ	1..1	Reference(Patient Profile - KPS)	The Age of the Patient
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	SΣC	1..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	Σ	0..1	string	Text alternative for the resource
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1	dateTime	Date of Immunization
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:data-absent-reason	S	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
recorded		0..1	dateTime	When the immunization was first captured in the subject's record
primarySource	Σ	0..1	boolean	Indicates context the data was recorded in
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	S	0..1	Reference(Location)	Location of Immunization
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber	S	0..1	string	Lot Number of Vaccine
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	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(Practitioner | PractitionerRole | Organization)	Performer of Immunization
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	?!Σ	0..1	boolean	Dose potency
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 Constraints: imm-1
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
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
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
series	S	1..1	string	Name of Vaccine Series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease	S	1..1	CodeableConcept	Target Disease of Immunization Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized. Additional Bindings Purpose Vaccine Target Diseases - SNOMED CT IPS Free Set candidate
doseNumber[x]	S	1..1	positiveInt	Dose Number in Series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
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	Vaccine Status ValueSet	📦0.1.0	This IG
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦4.0.1	FHIR Std.
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
Immunization.patient.​type	Base	extensible	ResourceType	📦4.0.1	FHIR Std.
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📦4.0.1	FHIR Std.
Immunization.site	Base	preferred	SNOMED CT Body Structures	📦4.0.1	FHIR Std.
Immunization.route	Base	preferred	Medicine Route of Administration - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1
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	preferred	Vaccine Target Diseases - IPS	📦1.1.0	International Patient Summary Implementation Guide v1.1

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()

This structure is derived from ImmunizationUvIps

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 6 elements

Structures

This structure refers to these other structures:

• Patient Profile - KPS (https://example.org/fhir/StructureDefinition/kps-patient)

Other representations of profile: CSV, Excel, Schematron