Polaris Core Immunization Profile

Overview

The Polaris Core Immunization profile represents vaccination records and immunization history within primary care EMR systems. This profile captures comprehensive immunization details including vaccine products, administration dates, sites, routes, and related clinical context across the Polaris ecosystem.

Key Features

• Flexible Vaccine Coding: Supports CVX, SNOMED CT, and source EMR vaccine codes
• Administration Details: Captures site, route, and dose information
• Status Tracking: Distinguishes completed, not-done, and entered-in-error immunizations
• Clinical Context: Links to encounters and healthcare providers
• Historical Records: Supports both administered and historical immunizations

Vaccine Documentation

Essential elements include:

• Vaccine Product: Name and codes (CVX, SNOMED CT, or local)
• Administration Date: When the vaccine was given
• Body Site: Anatomical location of administration
• Route: How the vaccine entered the body
• Lot Number: For tracking and recall purposes
• Expiration Date: Vaccine product expiration

Clinical Use Cases

This profile supports various immunization scenarios:

• Routine childhood vaccinations
• Annual flu shots and boosters
• Travel immunizations
• COVID-19 vaccination series
• Historical immunization documentation
• Contraindicated vaccines

Public Health Integration

Supports reporting requirements for:

• Provincial immunization registries
• Public health surveillance
• School immunization records
• Outbreak management
• Vaccine coverage reporting

Future Considerations

Potential enhancements being evaluated:

• Dose number in series tracking
• Vaccine eligibility criteria
• Adverse event associations
• Immunization recommendations engine
• Vaccine inventory management
• Patient education materials linking

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Immunization	Polaris Immunization Core Constraints: immunization-has-polaris-id
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	S	0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier(s) for immunization Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris Immunization ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	Polaris immunization identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-immunization-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris immunization ID value: unique in source system Example General: 123456
identifier:rawCode	S	0..*	Identifier	Source EMR immunization identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	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)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product with raw code support Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard vaccine code (CVX, SNOMED CT) if available
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR vaccine code if value
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-vaccinecode-raw-code
code	Σ	1..1	code	EMR-specific vaccine code
display	Σ	1..1	string	EMR's display text for this vaccine
text	SΣ	1..1	string	Human-readable vaccine name (required)
patient	SΣ	1..1	Reference(Polaris Patient Core)	Who was immunized
encounter	S	0..1	Reference(Polaris Encounter Profile Core)	Encounter when immunization was given
occurrence[x]	SΣ	1..1	dateTime	When vaccine was administered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason	S	0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
lotNumber	S	0..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site with raw code support Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard body site code (SNOMED CT)
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR body site code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-site-raw-code
code	Σ	1..1	code	EMR-specific body site code
display	Σ	1..1	string	EMR's display text for this body site
route	S	0..1	CodeableConcept	Administration route with raw code support Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard route code (SNOMED CT)
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR route code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-route-raw-code
code	Σ	1..1	code	EMR-specific route code
display	Σ	1..1	string	EMR's display text for this route
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed the immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Polaris PractitionerRole Core)	Individual who administered the vaccine
note	SΣ	0..*	Annotation	Additional immunization notes
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Immunization.identifier:rawCode.use	required	Pattern Value: secondary 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 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

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()
immunization-has-polaris-id	error	Immunization	Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-immunization-identifier$'))

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Immunization	Polaris Immunization Core Constraints: immunization-has-polaris-id
meta
source	S	0..1	uri	Identifies EMR instance & pipeline version the resource came from
text	S	0..1	Narrative	Narrative
Slices for identifier	S	1..*	Identifier	Business identifier(s) for immunization Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris Immunization ID
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	Polaris immunization identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-immunization-identifier
value		1..1	string	The actual Polaris immunization ID value: unique in source system
identifier:rawCode	S	0..*	Identifier	Source EMR immunization identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: secondary
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-raw-code
value		1..1	string	The value that is unique
status	S	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
vaccineCode	S	1..1	CodeableConcept	Vaccine product with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard vaccine code (CVX, SNOMED CT) if available
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR vaccine code if value
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-vaccinecode-raw-code
code		1..1	code	EMR-specific vaccine code
display		1..1	string	EMR's display text for this vaccine
text	S	1..1	string	Human-readable vaccine name (required)
patient	S	1..1	Reference(Polaris Patient Core)	Who was immunized
encounter	S	0..1	Reference(Polaris Encounter Profile Core)	Encounter when immunization was given
occurrence[x]	S	1..1	dateTime	When vaccine was administered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason	S	0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
lotNumber	S	0..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard body site code (SNOMED CT)
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR body site code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-site-raw-code
code		1..1	code	EMR-specific body site code
display		1..1	string	EMR's display text for this body site
route	S	0..1	CodeableConcept	Administration route with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard route code (SNOMED CT)
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR route code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-route-raw-code
code		1..1	code	EMR-specific route code
display		1..1	string	EMR's display text for this route
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
performer	S	0..1	BackboneElement	Who performed the immunization
actor	S	1..1	Reference(Polaris PractitionerRole Core)	Individual who administered the vaccine
note	S	0..*	Annotation	Additional immunization notes
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
immunization-has-polaris-id	error	Immunization	Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-immunization-identifier$'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Immunization	Polaris Immunization Core Constraints: immunization-has-polaris-id
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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	S	0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier(s) for immunization Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris Immunization ID
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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
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	Σ	1..1	uri	Polaris immunization identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-immunization-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris immunization ID value: unique in source system 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)
identifier:rawCode	S	0..*	Identifier	Source EMR immunization 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
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	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	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)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product with raw code support Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard vaccine code (CVX, SNOMED CT) if available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR vaccine code if value
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-vaccinecode-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific vaccine code
display	Σ	1..1	string	EMR's display text for this vaccine
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	1..1	string	Human-readable vaccine name (required)
patient	SΣ	1..1	Reference(Polaris Patient Core)	Who was immunized
encounter	S	0..1	Reference(Polaris Encounter Profile Core)	Encounter when immunization was given
occurrence[x]	SΣ	1..1	dateTime	When vaccine was administered
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason	S	0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
value		0..1	dateTime	Primitive value for dateTime
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		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber	S	0..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site with raw code support Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard body site code (SNOMED CT)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR body site code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-site-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific body site code
display	Σ	1..1	string	EMR's display text for this body site
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
route	S	0..1	CodeableConcept	Administration route with raw code support Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard route code (SNOMED CT)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR route code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-route-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific route code
display	Σ	1..1	string	EMR's display text for this route
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed the 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
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Polaris PractitionerRole Core)	Individual who administered the vaccine
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		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 / Code	URI
Immunization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Immunization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Immunization.identifier:polarisId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Immunization.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Immunization.identifier:rawCode.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 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()
immunization-has-polaris-id	error	Immunization	Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-immunization-identifier$'))

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Immunization	Polaris Immunization Core Constraints: immunization-has-polaris-id
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text	S	0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier(s) for immunization Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris Immunization ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	Polaris immunization identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-immunization-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris immunization ID value: unique in source system Example General: 123456
identifier:rawCode	S	0..*	Identifier	Source EMR immunization identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	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)
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product with raw code support Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard vaccine code (CVX, SNOMED CT) if available
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR vaccine code if value
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-vaccinecode-raw-code
code	Σ	1..1	code	EMR-specific vaccine code
display	Σ	1..1	string	EMR's display text for this vaccine
text	SΣ	1..1	string	Human-readable vaccine name (required)
patient	SΣ	1..1	Reference(Polaris Patient Core)	Who was immunized
encounter	S	0..1	Reference(Polaris Encounter Profile Core)	Encounter when immunization was given
occurrence[x]	SΣ	1..1	dateTime	When vaccine was administered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason	S	0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
lotNumber	S	0..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site with raw code support Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard body site code (SNOMED CT)
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR body site code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-site-raw-code
code	Σ	1..1	code	EMR-specific body site code
display	Σ	1..1	string	EMR's display text for this body site
route	S	0..1	CodeableConcept	Administration route with raw code support Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard route code (SNOMED CT)
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR route code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-route-raw-code
code	Σ	1..1	code	EMR-specific route code
display	Σ	1..1	string	EMR's display text for this route
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed the immunization
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(Polaris PractitionerRole Core)	Individual who administered the vaccine
note	SΣ	0..*	Annotation	Additional immunization notes
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Immunization.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Immunization.identifier:rawCode.use	required	Pattern Value: secondary 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 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

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()
immunization-has-polaris-id	error	Immunization	Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-immunization-identifier$'))

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Immunization	Polaris Immunization Core Constraints: immunization-has-polaris-id
meta
source	S	0..1	uri	Identifies EMR instance & pipeline version the resource came from
text	S	0..1	Narrative	Narrative
Slices for identifier	S	1..*	Identifier	Business identifier(s) for immunization Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris Immunization ID
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	Polaris immunization identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-immunization-identifier
value		1..1	string	The actual Polaris immunization ID value: unique in source system
identifier:rawCode	S	0..*	Identifier	Source EMR immunization identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: secondary
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-raw-code
value		1..1	string	The value that is unique
status	S	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required)
vaccineCode	S	1..1	CodeableConcept	Vaccine product with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard vaccine code (CVX, SNOMED CT) if available
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR vaccine code if value
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-vaccinecode-raw-code
code		1..1	code	EMR-specific vaccine code
display		1..1	string	EMR's display text for this vaccine
text	S	1..1	string	Human-readable vaccine name (required)
patient	S	1..1	Reference(Polaris Patient Core)	Who was immunized
encounter	S	0..1	Reference(Polaris Encounter Profile Core)	Encounter when immunization was given
occurrence[x]	S	1..1	dateTime	When vaccine was administered
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason	S	0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
lotNumber	S	0..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard body site code (SNOMED CT)
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR body site code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-site-raw-code
code		1..1	code	EMR-specific body site code
display		1..1	string	EMR's display text for this body site
route	S	0..1	CodeableConcept	Administration route with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard route code (SNOMED CT)
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR route code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-route-raw-code
code		1..1	code	EMR-specific route code
display		1..1	string	EMR's display text for this route
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
performer	S	0..1	BackboneElement	Who performed the immunization
actor	S	1..1	Reference(Polaris PractitionerRole Core)	Individual who administered the vaccine
note	S	0..*	Annotation	Additional immunization notes
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
immunization-has-polaris-id	error	Immunization	Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-immunization-identifier$'))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization	C	0..*	Immunization	Polaris Immunization Core Constraints: immunization-has-polaris-id
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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	S	0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	S	1..*	Identifier	Business identifier(s) for immunization Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris Immunization ID
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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
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	Σ	1..1	uri	Polaris immunization identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-immunization-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris immunization ID value: unique in source system 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)
identifier:rawCode	S	0..*	Identifier	Source EMR immunization 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
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	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	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)
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product with raw code support Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard vaccine code (CVX, SNOMED CT) if available
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR vaccine code if value
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-vaccinecode-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific vaccine code
display	Σ	1..1	string	EMR's display text for this vaccine
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	SΣ	1..1	string	Human-readable vaccine name (required)
patient	SΣ	1..1	Reference(Polaris Patient Core)	Who was immunized
encounter	S	0..1	Reference(Polaris Encounter Profile Core)	Encounter when immunization was given
occurrence[x]	SΣ	1..1	dateTime	When vaccine was administered
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason	S	0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.
value		0..1	dateTime	Primitive value for dateTime
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		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber	S	0..1	string	Vaccine lot number
expirationDate	S	0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site with raw code support Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard body site code (SNOMED CT)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR body site code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-site-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific body site code
display	Σ	1..1	string	EMR's display text for this body site
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
route	S	0..1	CodeableConcept	Administration route with raw code support Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard route code (SNOMED CT)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR route code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-immunization-route-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific route code
display	Σ	1..1	string	EMR's display text for this route
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
doseQuantity	S	0..1	SimpleQuantity	Amount of vaccine administered
performer	SΣ	0..1	BackboneElement	Who performed the 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
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	SΣ	1..1	Reference(Polaris PractitionerRole Core)	Individual who administered the vaccine
note	SΣ	0..*	Annotation	Additional immunization notes
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date		0..1	dateTime	When reaction started
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		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 / Code	URI
Immunization.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Immunization.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Immunization.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Immunization.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Immunization.identifier:polarisId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Immunization.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Immunization.identifier:rawCode.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 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()
immunization-has-polaris-id	error	Immunization	Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-immunization-identifier$'))

This structure is derived from Immunization

Summary

Mandatory: 5 elements(17 nested mandatory elements)
Must-Support: 26 elements

Structures

This structure refers to these other structures:

• Polaris Patient Core (https://fhir.apps.health/StructureDefinition/polaris-core-patient)
• Polaris Encounter Profile Core (https://fhir.apps.health/StructureDefinition/polaris-core-encounter)
• Polaris PractitionerRole Core (https://fhir.apps.health/StructureDefinition/polaris-core-practitionerrole)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/data-absent-reason|4.0.1

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.identifier
• The element 1 is sliced based on the value of Immunization.vaccineCode.coding
• The element 1 is sliced based on the value of Immunization.site.coding
• The element 1 is sliced based on the value of Immunization.route.coding