GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions

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

Resource Profile: DVC - WHO PreQual Immunization for IPS

This profile represents an IPS Immunization record that can be mapped onto a Digital Vaccine Certificates using the WHO PreQual Database

Usages:

• Use this Profile: DVC Certificate - IPS Bundle for WHO PreQual Databae
• Refer to this Profile: DVC Certificate - IPS Composition for WHO PreQual Database

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..*	Immunization-uv-ips-DVC	Immunization event information
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.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID	S This element must be supported.	1..1	Coding, Reference(Medication Catalog Item)	Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: immunization-status|4.0.1 (??) (required): A set of codes indicating the current status of an Immunization.
Immunization.vaccineCode	S This element must be supported.	1..1	CodeableConceptIPS	Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. 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 WHO ATC - IPS candidate For when WHO ATC code system is preferred
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Patient (IPS))	Who was immunized
Immunization.patient.reference	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
Immunization.occurrence[x]	S This element must be supported. Σ This element is included in summaries.	1..1		Vaccine administration date
Immunization.occurrence[x].occurrence[x]All Types				Content/Rules for all Types
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension				Content/Rules for all slices
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension.extension:data-absent-reason	S This element must be supported.	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
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	http://hl7.org/fhir/ValueSet/immunization-status|4.0.1	📍4.0.1	Unknown
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0

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 Immunization-uv-ips-DVC

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization-uv-ips-DVC	Immunization event information
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization-uv-ips-DVC	Immunization event information
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.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID	S This element must be supported.	1..1	Coding, Reference(Medication Catalog Item)	Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	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	completed | entered-in-error | not-done Binding: immunization-status|4.0.1 (??) (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode	S This element must be supported.	1..1	CodeableConceptIPS	Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. 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 WHO ATC - IPS candidate For when WHO ATC code system is preferred
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Patient (IPS))	Who was immunized
Immunization.patient.id		0..1	string	Unique id for inter-element referencing
Immunization.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.patient.reference	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
Immunization.patient.type	Σ This element is included in summaries.	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).
Immunization.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.patient.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
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		Vaccine administration date
Immunization.occurrence[x].occurrence[x]All Types				Content/Rules for all Types
Immunization.occurrence[x].occurrence[x]All Types.id		0..1	string	Unique id for inter-element referencing
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension.extension:data-absent-reason	S This element must be supported.	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
Immunization.recorded		0..1	dateTime	When the immunization was first captured in the subject's record
Immunization.primarySource	Σ This element is included in summaries.	0..1	boolean	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	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
Immunization.route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
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 preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.
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	📦5.0.0	FHIR Std.
Immunization.status	Base	required	http://hl7.org/fhir/ValueSet/immunization-status|4.0.1	📍4.0.1	Unknown
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦5.0.0	FHIR Std.
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0
Immunization.patient.​type	Base	extensible	Resource Types	📦5.0.0	FHIR Std.
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📦5.0.0	FHIR Std.
Immunization.site	Base	preferred	SNOMED CT Body Structures	📦5.0.0	FHIR Std.
Immunization.route	Base	preferred	Medicine Route of Administration - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📦5.0.0	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📦5.0.0	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📦5.0.0	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📦5.0.0	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📦5.0.0	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	preferred	Vaccine Target Diseases - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0

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

This structure is derived from Immunization-uv-ips-DVC

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization-uv-ips-DVC	Immunization event information
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.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID	S This element must be supported.	1..1	Coding, Reference(Medication Catalog Item)	Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: immunization-status|4.0.1 (??) (required): A set of codes indicating the current status of an Immunization.
Immunization.vaccineCode	S This element must be supported.	1..1	CodeableConceptIPS	Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. 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 WHO ATC - IPS candidate For when WHO ATC code system is preferred
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Patient (IPS))	Who was immunized
Immunization.patient.reference	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
Immunization.occurrence[x]	S This element must be supported. Σ This element is included in summaries.	1..1		Vaccine administration date
Immunization.occurrence[x].occurrence[x]All Types				Content/Rules for all Types
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension				Content/Rules for all slices
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension.extension:data-absent-reason	S This element must be supported.	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
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	http://hl7.org/fhir/ValueSet/immunization-status|4.0.1	📍4.0.1	Unknown
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0

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 Immunization-uv-ips-DVC

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization-uv-ips-DVC	Immunization event information
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization-uv-ips-DVC	Immunization event information
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.Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID	S This element must be supported.	1..1	Coding, Reference(Medication Catalog Item)	Extension URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	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	completed | entered-in-error | not-done Binding: immunization-status|4.0.1 (??) (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode	S This element must be supported.	1..1	CodeableConceptIPS	Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. 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 WHO ATC - IPS candidate For when WHO ATC code system is preferred
Immunization.patient	S This element must be supported. Σ This element is included in summaries.	1..1	Reference(Patient (IPS))	Who was immunized
Immunization.patient.id		0..1	string	Unique id for inter-element referencing
Immunization.patient.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.patient.reference	S This element must be supported. Σ This element is included in summaries. C	1..1	string	Literal reference, Relative, internal or absolute URL
Immunization.patient.type	Σ This element is included in summaries.	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).
Immunization.patient.identifier	Σ This element is included in summaries.	0..1	Identifier	Logical reference, when literal reference is not known
Immunization.patient.display	Σ This element is included in summaries.	0..1	string	Text alternative for the resource
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		Vaccine administration date
Immunization.occurrence[x].occurrence[x]All Types				Content/Rules for all Types
Immunization.occurrence[x].occurrence[x]All Types.id		0..1	string	Unique id for inter-element referencing
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Immunization.occurrence[x].occurrence[x]All Types.Slices for extension.extension:data-absent-reason	S This element must be supported.	0..1	code	occurrence[x] absence reason URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
Immunization.recorded		0..1	dateTime	When the immunization was first captured in the subject's record
Immunization.primarySource	Σ This element is included in summaries.	0..1	boolean	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	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: SNOMEDCTBodyStructures (preferred)
Immunization.route		0..1	CodeableConceptIPS	Concept - reference to a terminology or just text Binding: Medicine Route of Administration - IPS (preferred)
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 preventable disease being targeted Binding: Vaccine Target Diseases - IPS (preferred): The particular disease or diseases against which the patient has been immunized.
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	📦5.0.0	FHIR Std.
Immunization.status	Base	required	http://hl7.org/fhir/ValueSet/immunization-status|4.0.1	📍4.0.1	Unknown
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📦5.0.0	FHIR Std.
Immunization.vaccineCode	Base	preferred	Vaccines - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0
Immunization.patient.​type	Base	extensible	Resource Types	📦5.0.0	FHIR Std.
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📦5.0.0	FHIR Std.
Immunization.site	Base	preferred	SNOMED CT Body Structures	📦5.0.0	FHIR Std.
Immunization.route	Base	preferred	Medicine Route of Administration - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📦5.0.0	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📦5.0.0	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📦5.0.0	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📦5.0.0	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📦5.0.0	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	preferred	Vaccine Target Diseases - IPS	📦2.0.0-ballot	International Patient Summary Implementation Guide v2.0

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

This structure is derived from Immunization-uv-ips-DVC

Summary

Other representations of profile: CSV, Excel, Schematron