SMART Base Clinical, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base-clinical/ and changes regularly. See the Directory of published versions

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

Resource Profile: WHO SMART Guidelines Immunization

The WHO SMART Guidelines Immunization profile defines conformance requirements and exchange expectations for Immunization resources in WHO Smart Guidelines content.

Usage:

• Refer to this Resource Profile: WHO SMART Guidelines CarePlan

Formal Views of Profile Content

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

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

This structure is derived from CPGImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization	S	0..*	CPGImmunization	Immunization event information
identifier	S	1..*	Identifier	Business identifier
use	S	1..1	code	usual | official | temp | secondary | old (If known)
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
status	S	1..1	code	completed | entered-in-error | not-done
statusReason	S	0..1	CodeableConcept	Reason not done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
patient	S	1..1	Reference(WHO SMART Guidelines Patient)	Who was immunized
encounter	S	0..1	Reference(WHO SMART Guidelines Encounter)	Encounter immunization was part of
occurrence[x]	S	1..1	dateTime	Vaccine administration date
recorded	S	1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	S	0..1	boolean	Indicates context the data was recorded in
location	S	0..1	Reference(WHO SMART Guidelines Location)	Where immunization occurred
site	S	0..1	CodeableConcept	Body site vaccine was administered
route	S	0..1	CodeableConcept	How vaccine entered body
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
reasonCode	S	0..*	CodeableConcept	Why immunization occurred
isSubpotent	S	0..1	boolean	Dose potency
subpotentReason	S	0..*	CodeableConcept	Reason for being subpotent
reaction	S	0..*	BackboneElement	Details of a reaction that follows immunization
detail	S	0..1	Reference(WHO SMART Guidelines Observation)	Additional information on reaction
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization	S	0..*	CPGImmunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
instantiatesCaseFeature	S	0..1	canonical(CPG Case Feature Definition)	CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
caseFeatureType	S	0..1	code	CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
caseFeaturePertinence	S	0..1	code	CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
basedOn	S	0..1	Reference(Resource)	Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
pertinent	S	0..*	Reference()	CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier	Business identifier
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(WHO SMART Guidelines Patient)	Who was immunized
encounter	S	0..1	Reference(WHO SMART Guidelines Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1	dateTime	Vaccine administration date
recorded	S	1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SΣ	0..1	boolean	Indicates context the data was recorded in
location	S	0..1	Reference(WHO SMART Guidelines Location)	Where immunization occurred
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference	S	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!SΣ	0..1	boolean	Dose potency
subpotentReason	S	0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
reaction	S	0..*	BackboneElement	Details of a reaction that follows immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
detail	S	0..1	Reference(WHO SMART Guidelines Observation)	Additional information on reaction
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code 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.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

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

Name	Flags	Card.	Type	Description & Constraints
Immunization	S	0..*	CPGImmunization	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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
instantiatesCaseFeature	S	0..1	canonical(CPG Case Feature Definition)	CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
caseFeatureType	S	0..1	code	CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
caseFeaturePertinence	S	0..1	code	CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
basedOn	S	0..1	Reference(Resource)	Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
pertinent	S	0..*	Reference()	CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier	Business identifier
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	?!SΣ	1..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	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	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)
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(WHO SMART Guidelines Patient)	Who was immunized
encounter	S	0..1	Reference(WHO SMART Guidelines Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1	dateTime	Vaccine administration date
recorded	S	1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SΣ	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(WHO SMART Guidelines Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity	S	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	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference	S	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!SΣ	0..1	boolean	Dose potency
subpotentReason	S	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	S	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	S	0..1	Reference(WHO SMART Guidelines 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		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin 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.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()

This structure is derived from CPGImmunization

Summary

Mandatory: 5 elements
Must-Support: 21 elements

Structures

This structure refers to these other structures:

• WHO SMART Guidelines Patient (http://smart.who.int/base-clinical/StructureDefinition/sg-patient)
• WHO SMART Guidelines Encounter (http://smart.who.int/base-clinical/StructureDefinition/sg-encounter)
• WHO SMART Guidelines Location (http://smart.who.int/base-clinical/StructureDefinition/sg-location)
• WHO SMART Guidelines Observation (http://smart.who.int/base-clinical/StructureDefinition/sg-observation)

Differential View

This structure is derived from CPGImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization	S	0..*	CPGImmunization	Immunization event information
identifier	S	1..*	Identifier	Business identifier
use	S	1..1	code	usual | official | temp | secondary | old (If known)
system	S	1..1	uri	The namespace for the identifier value
value	S	1..1	string	The value that is unique
status	S	1..1	code	completed | entered-in-error | not-done
statusReason	S	0..1	CodeableConcept	Reason not done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
patient	S	1..1	Reference(WHO SMART Guidelines Patient)	Who was immunized
encounter	S	0..1	Reference(WHO SMART Guidelines Encounter)	Encounter immunization was part of
occurrence[x]	S	1..1	dateTime	Vaccine administration date
recorded	S	1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	S	0..1	boolean	Indicates context the data was recorded in
location	S	0..1	Reference(WHO SMART Guidelines Location)	Where immunization occurred
site	S	0..1	CodeableConcept	Body site vaccine was administered
route	S	0..1	CodeableConcept	How vaccine entered body
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
reasonCode	S	0..*	CodeableConcept	Why immunization occurred
isSubpotent	S	0..1	boolean	Dose potency
subpotentReason	S	0..*	CodeableConcept	Reason for being subpotent
reaction	S	0..*	BackboneElement	Details of a reaction that follows immunization
detail	S	0..1	Reference(WHO SMART Guidelines Observation)	Additional information on reaction
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization	S	0..*	CPGImmunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
instantiatesCaseFeature	S	0..1	canonical(CPG Case Feature Definition)	CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
caseFeatureType	S	0..1	code	CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
caseFeaturePertinence	S	0..1	code	CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
basedOn	S	0..1	Reference(Resource)	Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
pertinent	S	0..*	Reference()	CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier	Business identifier
use	?!SΣ	1..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(WHO SMART Guidelines Patient)	Who was immunized
encounter	S	0..1	Reference(WHO SMART Guidelines Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1	dateTime	Vaccine administration date
recorded	S	1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SΣ	0..1	boolean	Indicates context the data was recorded in
location	S	0..1	Reference(WHO SMART Guidelines Location)	Where immunization occurred
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference	S	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!SΣ	0..1	boolean	Dose potency
subpotentReason	S	0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
reaction	S	0..*	BackboneElement	Details of a reaction that follows immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
detail	S	0..1	Reference(WHO SMART Guidelines Observation)	Additional information on reaction
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code 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.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

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization	S	0..*	CPGImmunization	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
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
instantiatesCaseFeature	S	0..1	canonical(CPG Case Feature Definition)	CPG Instantiates Case Feature Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-instantiatesCaseFeature
caseFeatureType	S	0..1	code	CPG Case Feature Type Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeatureType Binding: CPG Case Feature Type Value Set (required): Whether the case feature is asserted or inferred
caseFeaturePertinence	S	0..1	code	CPG Case Feature Pertinence Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-caseFeaturePertinence Binding: CPG Case Feature Pertinence Value Set (required): Describes the pertinence of a case feature
basedOn	S	0..1	Reference(Resource)	Fulfills plan, proposal or order URL: http://hl7.org/fhir/StructureDefinition/event-basedOn
pertinent	S	0..*	Reference()	CPG Pertinent Extension URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-pertinent
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	S	1..*	Identifier	Business identifier
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	?!SΣ	1..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	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	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)
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(WHO SMART Guidelines Patient)	Who was immunized
encounter	S	0..1	Reference(WHO SMART Guidelines Encounter)	Encounter immunization was part of
occurrence[x]	SΣ	1..1	dateTime	Vaccine administration date
recorded	S	1..1	dateTime	When the immunization was first captured in the subject's record
primarySource	SΣ	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(WHO SMART Guidelines Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity	S	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	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference	S	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!SΣ	0..1	boolean	Dose potency
subpotentReason	S	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	S	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	S	0..1	Reference(WHO SMART Guidelines 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		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Immunization.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin 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.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()

This structure is derived from CPGImmunization

Summary

Mandatory: 5 elements
Must-Support: 21 elements

Structures

This structure refers to these other structures:

• WHO SMART Guidelines Patient (http://smart.who.int/base-clinical/StructureDefinition/sg-patient)
• WHO SMART Guidelines Encounter (http://smart.who.int/base-clinical/StructureDefinition/sg-encounter)
• WHO SMART Guidelines Location (http://smart.who.int/base-clinical/StructureDefinition/sg-location)
• WHO SMART Guidelines Observation (http://smart.who.int/base-clinical/StructureDefinition/sg-observation)

Other representations of profile: CSV, Excel, Schematron