COVID19 Case Reporting - Local Development build (v0.1.0). See the Directory of published versions

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

Resource Profile: Immunization Tracking

Retrospectively capture COVID19 immunization data for vaccines administered at other organizations

Usage:

• Examples for this Resource Profile: Immunization/Covid19AssessmentVaccinationExample

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 Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
status		1..1	code	completed | entered-in-error | not-done Required Pattern: completed
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: Vaccine Types (required)
encounter		1..1	Reference(Encounter)	Encounter immunization was part of
occurrenceDateTime		1..1	dateTime	Vaccine administration date
reportOrigin		1..1	CodeableConcept	Indicates the source of a secondarily reported record
coding
code		0..1	code	Symbol in syntax defined by the system Binding: Source of Information (required)
lotNumber		1..1	string	Vaccine lot number
note		0..1	Annotation	Additional immunization notes
authorReference		0..1	Reference(Organization)	Individual responsible for the annotation
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
series		1..1	string	Name of vaccine series
doseNumberPositiveInt		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Immunization.vaccineCode	required	VSVaccineTypes
Immunization.reportOrigin.coding.code	required	VSSourceOfInfo (a valid code from Source of Information)

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccine Types (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
encounter		1..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	Σ	1..1	dateTime	Vaccine administration date
reportOrigin		1..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.
lotNumber		1..1	string	Vaccine lot number
note	Σ	0..1	Annotation	Additional immunization notes
Slices for author[x]	Σ	0..1		Individual responsible for the annotation Slice: Unordered, Open by type:$this
authorReference			Reference(Practitioner | Patient | RelatedPerson | Organization)
authorString			string
author[x]:authorReference	Σ	0..1	Reference(Organization)	Individual responsible for the annotation
text	Σ	1..1	markdown	The annotation - text content (as markdown)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		1..1	string	Name of vaccine series
Slices for doseNumber[x]		1..1	positiveInt	Dose number within series Slice: Unordered, Closed by type:$this
doseNumber[x]:doseNumberPositiveInt		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.status	required	Pattern: completed
Immunization.vaccineCode	required	VSVaccineTypes
Immunization.reportOrigin	example	ImmunizationOriginCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccine Types (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
encounter		1..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	Σ	1..1	dateTime	Vaccine administration date
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		1..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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: Source of Information (required)
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		1..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	Σ	0..1	Annotation	Additional immunization notes
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 author[x]	Σ	0..1		Individual responsible for the annotation Slice: Unordered, Open by type:$this
authorReference			Reference(Practitioner | Patient | RelatedPerson | Organization)
authorString			string
author[x]:authorReference	Σ	0..1	Reference(Organization)	Individual responsible for the annotation
time	Σ	0..1	dateTime	When the annotation was made
text	Σ	1..1	markdown	The annotation - text content (as markdown)
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
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		1..1	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		1..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.
Slices for doseNumber[x]		1..1	positiveInt	Dose number within series Slice: Unordered, Closed by type:$this
doseNumber[x]:doseNumberPositiveInt		1..1	positiveInt	Dose number within series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	Pattern: completed
Immunization.statusReason	example	ImmunizationStatusReasonCodes
Immunization.vaccineCode	required	VSVaccineTypes
Immunization.reportOrigin	example	ImmunizationOriginCodes
Immunization.reportOrigin.coding.code	required	VSSourceOfInfo (a valid code from Source of Information)
Immunization.site	example	CodesForImmunizationSiteOfAdministration
Immunization.route	example	ImmunizationRouteCodes
Immunization.performer.function	extensible	ImmunizationFunctionCodes
Immunization.reasonCode	example	ImmunizationReasonCodes
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 7 elements

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
status		1..1	code	completed | entered-in-error | not-done Required Pattern: completed
vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: Vaccine Types (required)
encounter		1..1	Reference(Encounter)	Encounter immunization was part of
occurrenceDateTime		1..1	dateTime	Vaccine administration date
reportOrigin		1..1	CodeableConcept	Indicates the source of a secondarily reported record
coding
code		0..1	code	Symbol in syntax defined by the system Binding: Source of Information (required)
lotNumber		1..1	string	Vaccine lot number
note		0..1	Annotation	Additional immunization notes
authorReference		0..1	Reference(Organization)	Individual responsible for the annotation
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
series		1..1	string	Name of vaccine series
doseNumberPositiveInt		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Immunization.vaccineCode	required	VSVaccineTypes
Immunization.reportOrigin.coding.code	required	VSSourceOfInfo (a valid code from Source of Information)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccine Types (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
encounter		1..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	Σ	1..1	dateTime	Vaccine administration date
reportOrigin		1..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.
lotNumber		1..1	string	Vaccine lot number
note	Σ	0..1	Annotation	Additional immunization notes
Slices for author[x]	Σ	0..1		Individual responsible for the annotation Slice: Unordered, Open by type:$this
authorReference			Reference(Practitioner | Patient | RelatedPerson | Organization)
authorString			string
author[x]:authorReference	Σ	0..1	Reference(Organization)	Individual responsible for the annotation
text	Σ	1..1	markdown	The annotation - text content (as markdown)
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		1..1	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		1..1	string	Name of vaccine series
Slices for doseNumber[x]		1..1	positiveInt	Dose number within series Slice: Unordered, Closed by type:$this
doseNumber[x]:doseNumberPositiveInt		1..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.status	required	Pattern: completed
Immunization.vaccineCode	required	VSVaccineTypes
Immunization.reportOrigin	example	ImmunizationOriginCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	Immunization event information
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!Σ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	Σ	1..1	CodeableConcept	Vaccine product administered Binding: Vaccine Types (required)
patient	Σ	1..1	Reference(Patient)	Who was immunized
encounter		1..1	Reference(Encounter)	Encounter immunization was part of
Slices for occurrence[x]	Σ	1..1	dateTime	Vaccine administration date Slice: Unordered, Closed by type:$this
occurrence[x]:occurrenceDateTime	Σ	1..1	dateTime	Vaccine administration date
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		1..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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Binding: Source of Information (required)
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		1..1	string	Vaccine lot number
expirationDate		0..1	date	Vaccine expiration date
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
note	Σ	0..1	Annotation	Additional immunization notes
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 author[x]	Σ	0..1		Individual responsible for the annotation Slice: Unordered, Open by type:$this
authorReference			Reference(Practitioner | Patient | RelatedPerson | Organization)
authorString			string
author[x]:authorReference	Σ	0..1	Reference(Organization)	Individual responsible for the annotation
time	Σ	0..1	dateTime	When the annotation was made
text	Σ	1..1	markdown	The annotation - text content (as markdown)
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
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		1..1	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		1..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.
Slices for doseNumber[x]		1..1	positiveInt	Dose number within series Slice: Unordered, Closed by type:$this
doseNumber[x]:doseNumberPositiveInt		1..1	positiveInt	Dose number within series
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Immunization.status	required	Pattern: completed
Immunization.statusReason	example	ImmunizationStatusReasonCodes
Immunization.vaccineCode	required	VSVaccineTypes
Immunization.reportOrigin	example	ImmunizationOriginCodes
Immunization.reportOrigin.coding.code	required	VSSourceOfInfo (a valid code from Source of Information)
Immunization.site	example	CodesForImmunizationSiteOfAdministration
Immunization.route	example	ImmunizationRouteCodes
Immunization.performer.function	extensible	ImmunizationFunctionCodes
Immunization.reasonCode	example	ImmunizationReasonCodes
Immunization.subpotentReason	example	ImmunizationSubpotentReason
Immunization.programEligibility	example	ImmunizationProgramEligibility
Immunization.fundingSource	example	ImmunizationFundingSource
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()

This structure is derived from Immunization

Summary

Mandatory: 7 elements

Other representations of profile: CSV, Excel, Schematron