Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Resource Profile: Immunization

Extension to UKCore Immunization and includes elements from HL7 International Patient Access

Usage:

• Examples for this Resource Profile: Immunization/610266 and Immunization/610281

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 UKCoreImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	UKCoreImmunization	Immunization event information
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Closed by pattern:system
identifier:CommonResourceIdentifiers		0..*	CommonResourceIdentifiers	Common Resource Identifiers
patient		1..1	Reference(Patient)	Who was immunized
identifier		0..1	NHSNumbers	An identifier intended for computation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	UKCoreImmunization	Immunization event information ukcore-imm-001: If the immunization was not given then Immunization.status value SHALL = 'not-done', and the Immunization.statusReason SHALL be populated
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
parentPresent	N	0..1	boolean	Was a parent of the patient present at an immunisation? URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent
vaccinationProcedure	N	0..1	CodeableConcept	An extension to hold an immunization procedure code URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure Binding: UK Core Vaccination Procedure (preferred)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Closed by pattern:system
identifier:CommonResourceIdentifiers		0..*	CommonResourceIdentifiers	Common Resource Identifiers
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.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: UK Core Vaccine Code (preferred): The code for vaccine product administered.
patient	SΣC	1..1	Reference(Patient)	Who was immunized ref-1: SHALL have a contained resource if a local reference is provided
identifier		0..1	NHSNumbers	An identifier intended for computation
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
manufacturer	SC	0..1	Reference(Organization)	Vaccine manufacturer ref-1: SHALL have a contained resource if a local reference is provided
lotNumber	S	0..1	string	Vaccine lot number
doseQuantity	SC	0..1	SimpleQuantity	Amount of vaccine administered qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	preferred	UKCoreVaccineCode https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	UKCoreImmunization	Immunization event information ukcore-imm-001: If the immunization was not given then Immunization.status value SHALL = 'not-done', and the Immunization.statusReason SHALL be populated
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
parentPresent	N	0..1	boolean	Was a parent of the patient present at an immunisation? URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent
vaccinationProcedure	N	0..1	CodeableConcept	An extension to hold an immunization procedure code URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure Binding: UK Core Vaccination Procedure (preferred)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Closed by pattern:system
identifier:CommonResourceIdentifiers		0..*	CommonResourceIdentifiers	Common Resource Identifiers
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		0..1	CodeableConcept	Reason not done Binding: UK Core Reason Immunization Not Administered (preferred): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: UK Core Vaccine Code (preferred): The code for vaccine product administered.
patient	SΣC	1..1	Reference(Patient)	Who was immunized ref-1: SHALL have a contained resource if a local reference is provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier		0..1	NHSNumbers	An identifier intended for computation
display	Σ	0..1	string	Text alternative for the resource
encounter	C	0..1	Reference(Encounter)	Encounter immunization was part of ref-1: SHALL have a contained resource if a local reference is provided
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
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	C	0..1	Reference(Location)	Where immunization occurred ref-1: SHALL have a contained resource if a local reference is provided
manufacturer	SC	0..1	Reference(Organization)	Vaccine manufacturer ref-1: SHALL have a contained resource if a local reference is provided
lotNumber	S	0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: UK Core Immunization Administration Body Site (preferred): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: UK Core Substance Or Product Administration Route (preferred): The route by which the vaccine was administered.
doseQuantity	SC	0..1	SimpleQuantity	Amount of vaccine administered qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	ΣC	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ref-1: SHALL have a contained resource if a local reference is provided
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: UK Core Immunization Explanation Reason (preferred): The reason why a vaccine was administered.
reasonReference	C	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred ref-1: SHALL have a contained resource if a local reference is provided
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 imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail	C	0..1	Reference(Observation)	Additional information on reaction ref-1: SHALL have a contained resource if a local reference is provided
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority	C	0..1	Reference(Organization)	Who is responsible for publishing the recommendations ref-1: SHALL have a contained resource if a local reference is provided
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.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	preferred	UKCoreReasonImmunizationNotAdministered https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered
Immunization.vaccineCode	preferred	UKCoreVaccineCode https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	UKCoreImmunizationAdministrationBodySite https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationAdministrationBodySite
Immunization.route	preferred	UKCoreSubstanceOrProductAdministrationRoute https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	preferred	UKCoreImmunizationExplanationReason https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationExplanationReason
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

This structure is derived from UKCoreImmunization

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

• Common Resource Identifiers (https://fhir.virtually.healthcare/StructureDefinition/CommonResourceIdentifiers)
• Patient (https://fhir.virtually.healthcare/StructureDefinition/Patient)
• NHS, HCSN and CHI Numbers (https://fhir.virtually.healthcare/StructureDefinition/nhs-numbers)

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from UKCoreImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	UKCoreImmunization	Immunization event information
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Closed by pattern:system
identifier:CommonResourceIdentifiers		0..*	CommonResourceIdentifiers	Common Resource Identifiers
patient		1..1	Reference(Patient)	Who was immunized
identifier		0..1	NHSNumbers	An identifier intended for computation
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	UKCoreImmunization	Immunization event information ukcore-imm-001: If the immunization was not given then Immunization.status value SHALL = 'not-done', and the Immunization.statusReason SHALL be populated
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
parentPresent	N	0..1	boolean	Was a parent of the patient present at an immunisation? URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent
vaccinationProcedure	N	0..1	CodeableConcept	An extension to hold an immunization procedure code URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure Binding: UK Core Vaccination Procedure (preferred)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Closed by pattern:system
identifier:CommonResourceIdentifiers		0..*	CommonResourceIdentifiers	Common Resource Identifiers
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.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: UK Core Vaccine Code (preferred): The code for vaccine product administered.
patient	SΣC	1..1	Reference(Patient)	Who was immunized ref-1: SHALL have a contained resource if a local reference is provided
identifier		0..1	NHSNumbers	An identifier intended for computation
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
manufacturer	SC	0..1	Reference(Organization)	Vaccine manufacturer ref-1: SHALL have a contained resource if a local reference is provided
lotNumber	S	0..1	string	Vaccine lot number
doseQuantity	SC	0..1	SimpleQuantity	Amount of vaccine administered qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	preferred	UKCoreVaccineCode https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization	C	0..*	UKCoreImmunization	Immunization event information ukcore-imm-001: If the immunization was not given then Immunization.status value SHALL = 'not-done', and the Immunization.statusReason SHALL be populated
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
parentPresent	N	0..1	boolean	Was a parent of the patient present at an immunisation? URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent
vaccinationProcedure	N	0..1	CodeableConcept	An extension to hold an immunization procedure code URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure Binding: UK Core Vaccination Procedure (preferred)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	S	1..*	Identifier	Business identifier Slice: Unordered, Closed by pattern:system
identifier:CommonResourceIdentifiers		0..*	CommonResourceIdentifiers	Common Resource Identifiers
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		0..1	CodeableConcept	Reason not done Binding: UK Core Reason Immunization Not Administered (preferred): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: UK Core Vaccine Code (preferred): The code for vaccine product administered.
patient	SΣC	1..1	Reference(Patient)	Who was immunized ref-1: SHALL have a contained resource if a local reference is provided
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier		0..1	NHSNumbers	An identifier intended for computation
display	Σ	0..1	string	Text alternative for the resource
encounter	C	0..1	Reference(Encounter)	Encounter immunization was part of ref-1: SHALL have a contained resource if a local reference is provided
occurrence[x]	SΣ	1..1		Vaccine administration date
occurrenceDateTime			dateTime
occurrenceString			string
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	C	0..1	Reference(Location)	Where immunization occurred ref-1: SHALL have a contained resource if a local reference is provided
manufacturer	SC	0..1	Reference(Organization)	Vaccine manufacturer ref-1: SHALL have a contained resource if a local reference is provided
lotNumber	S	0..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: UK Core Immunization Administration Body Site (preferred): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: UK Core Substance Or Product Administration Route (preferred): The route by which the vaccine was administered.
doseQuantity	SC	0..1	SimpleQuantity	Amount of vaccine administered qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	ΣC	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing ref-1: SHALL have a contained resource if a local reference is provided
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: UK Core Immunization Explanation Reason (preferred): The reason why a vaccine was administered.
reasonReference	C	0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred ref-1: SHALL have a contained resource if a local reference is provided
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 imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail	C	0..1	Reference(Observation)	Additional information on reaction ref-1: SHALL have a contained resource if a local reference is provided
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority	C	0..1	Reference(Organization)	Who is responsible for publishing the recommendations ref-1: SHALL have a contained resource if a local reference is provided
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.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	preferred	UKCoreReasonImmunizationNotAdministered https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered
Immunization.vaccineCode	preferred	UKCoreVaccineCode https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	preferred	UKCoreImmunizationAdministrationBodySite https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationAdministrationBodySite
Immunization.route	preferred	UKCoreSubstanceOrProductAdministrationRoute https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	preferred	UKCoreImmunizationExplanationReason https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationExplanationReason
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

This structure is derived from UKCoreImmunization

Summary

Mandatory: 1 element
Must-Support: 1 element

Structures

This structure refers to these other structures:

• Common Resource Identifiers (https://fhir.virtually.healthcare/StructureDefinition/CommonResourceIdentifiers)
• Patient (https://fhir.virtually.healthcare/StructureDefinition/Patient)
• NHS, HCSN and CHI Numbers (https://fhir.virtually.healthcare/StructureDefinition/nhs-numbers)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron