Immunization validation

An immunization can be recorded by an Practitioner or a Patient (Extension: Author of the content) . In the case a practitioner is recorder, the immunization entry is directly validated. In the case a patient is recording an immunization, a practitioner has to validate the immunization entry.
Recorder == Patient means not validated
Recorder == PractitionerRole means validated

This can be done by changing the recorder of the immunization. This will be done by an Immunization Administration document which will replace the existing entry using the Extension ch-core-ext-entry-resource-cross-references.

Duplicate Conflict

By aggregation of different Immunization Administration documents, duplicates could be detected. If so, the entries in the Vaccination Record document (as result of the aggregation) should be completed with the extension CH VACD Extension Merging Conflict Entry Reference. The criterias of duplicate detection can be found here.

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

This structure is derived from CHCoreImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHCoreImmunization	CH VACD Immunization
contained		0..1	Resource	Immunization inline resource
Slices for extension				Content/Rules for all slices
extension:recorder	S	0..1	Author	Optional Extensions Element
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
medication		0..1	Reference(CH VACD Medication For Immunization)	Extension to reference immunization medication resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
status	S	1..1	code	completed | entered-in-error | not-done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD Swissmedic code for vaccine code (extensible)
Slices for coding				Content/Rules for all slices
coding:absentOrUnknownImmunization		0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
Slices for occurrence[x]		1..1	dateTime, string	Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime	S	0..1	dateTime	Vaccine administration date
lotNumber	S	0..1	string	Vaccine lot number
site	S	0..1	CodeableConcept	Body site vaccine was administered
route	S	0..1	CodeableConcept	How vaccine entered body.
performer
actor	S	1..1	Reference(CH Core PractitionerRole)	The performer who applied the vaccine
reasonCode	S	0..*	CodeableConcept	Why immunization occurred
protocolApplied
Slices for doseNumber[x]		1..1	positiveInt, string	Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	extensible	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	AbsentOrUnknownImmunizationUvIps http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHCoreImmunization	CH VACD Immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..1	Resource	Immunization inline resource
Slices for extension				Content/Rules for all slices
recorder	S	0..1	Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
medication		0..1	Reference(CH VACD Medication For Immunization)	Extension to reference immunization medication resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD Swissmedic code for vaccine code (extensible)
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:swissVaccines	Σ	0..1	Coding	Swiss Vaccine Code Binding: CH VACD Swissmedic code for vaccine code (required)
coding:snomedctVaccines	Σ	0..1	Coding	Vaccine Code by SNOMED CT Binding: CH VACD Snomed CT for vaccine code (required)
coding:absentOrUnknownImmunization	Σ	0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
patient	Σ	1..1	Reference(CH Core Patient)	Patient
Slices for occurrence[x]	Σ	1..1		Vaccine administration date Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	SΣ	0..1	dateTime	Vaccine administration date
lotNumber	S	0..1	string	Vaccine lot number
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
performer	Σ	0..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(CH Core PractitionerRole)	The performer who applied the vaccine
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	extensible	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccines	required	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccines	required	SnomedCTForVaccineCode http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	AbsentOrUnknownImmunizationUvIps http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	preferred	RouteOfAdministrationImmunization http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHCoreImmunization	CH VACD Immunization
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..1	Resource	Immunization inline resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
recorder	S	0..1	Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
medication		0..1	Reference(CH VACD Medication For Immunization)	Extension to reference immunization medication resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD Swissmedic code for vaccine code (extensible)
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:$this
coding:swissVaccines	Σ	0..1	Coding	Swiss Vaccine Code Binding: CH VACD Swissmedic code for vaccine code (required)
coding:snomedctVaccines	Σ	0..1	Coding	Vaccine Code by SNOMED CT Binding: CH VACD Snomed CT for vaccine code (required)
coding:absentOrUnknownImmunization	Σ	0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
text	Σ	0..1	string	Plain text representation of the concept
patient	Σ	1..1	Reference(CH Core Patient)	Patient
encounter		0..1	Reference(CH Core Encounter)	Encounter
Slices for occurrence[x]	Σ	1..1		Vaccine administration date Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	SΣ	0..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		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		0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
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	SΣ	1..1	Reference(CH Core PractitionerRole)	The performer who applied the vaccine
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode	S	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 imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		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: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..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	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	extensible	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccines	required	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccines	required	SnomedCTForVaccineCode http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	AbsentOrUnknownImmunizationUvIps http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips
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	preferred	RouteOfAdministrationImmunization http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
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	preferred	ChVacdTargetDiseasesAndIllnessesUndergoneForImmunization http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-targetdiseasesandillnessesundergoneforimmunization-vs

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

Differential View

This structure is derived from CHCoreImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHCoreImmunization	CH VACD Immunization
contained		0..1	Resource	Immunization inline resource
Slices for extension				Content/Rules for all slices
extension:recorder	S	0..1	Author	Optional Extensions Element
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
medication		0..1	Reference(CH VACD Medication For Immunization)	Extension to reference immunization medication resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
status	S	1..1	code	completed | entered-in-error | not-done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD Swissmedic code for vaccine code (extensible)
Slices for coding				Content/Rules for all slices
coding:absentOrUnknownImmunization		0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
Slices for occurrence[x]		1..1	dateTime, string	Vaccine administration date Slice: Unordered, Open by type:$this
occurrence[x]:occurrenceDateTime	S	0..1	dateTime	Vaccine administration date
lotNumber	S	0..1	string	Vaccine lot number
site	S	0..1	CodeableConcept	Body site vaccine was administered
route	S	0..1	CodeableConcept	How vaccine entered body.
performer
actor	S	1..1	Reference(CH Core PractitionerRole)	The performer who applied the vaccine
reasonCode	S	0..*	CodeableConcept	Why immunization occurred
protocolApplied
Slices for doseNumber[x]		1..1	positiveInt, string	Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Immunization.vaccineCode	extensible	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	AbsentOrUnknownImmunizationUvIps http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHCoreImmunization	CH VACD Immunization
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..1	Resource	Immunization inline resource
Slices for extension				Content/Rules for all slices
recorder	S	0..1	Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
medication		0..1	Reference(CH VACD Medication For Immunization)	Extension to reference immunization medication resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD Swissmedic code for vaccine code (extensible)
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:$this
coding:swissVaccines	Σ	0..1	Coding	Swiss Vaccine Code Binding: CH VACD Swissmedic code for vaccine code (required)
coding:snomedctVaccines	Σ	0..1	Coding	Vaccine Code by SNOMED CT Binding: CH VACD Snomed CT for vaccine code (required)
coding:absentOrUnknownImmunization	Σ	0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
patient	Σ	1..1	Reference(CH Core Patient)	Patient
Slices for occurrence[x]	Σ	1..1		Vaccine administration date Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	SΣ	0..1	dateTime	Vaccine administration date
lotNumber	S	0..1	string	Vaccine lot number
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
performer	Σ	0..*	BackboneElement	Who performed event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
actor	SΣ	1..1	Reference(CH Core PractitionerRole)	The performer who applied the vaccine
reasonCode	S	0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
isSubpotent	?!Σ	0..1	boolean	Dose potency
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..1	positiveInt	Dose number within series
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.vaccineCode	extensible	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccines	required	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccines	required	SnomedCTForVaccineCode http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	AbsentOrUnknownImmunizationUvIps http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	preferred	RouteOfAdministrationImmunization http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard

Constraints

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHCoreImmunization	CH VACD Immunization
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..1	Resource	Immunization inline resource
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
recorder	S	0..1	Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
medication		0..1	Reference(CH VACD Medication For Immunization)	Extension to reference immunization medication resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD Swissmedic code for vaccine code (extensible)
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:$this
coding:swissVaccines	Σ	0..1	Coding	Swiss Vaccine Code Binding: CH VACD Swissmedic code for vaccine code (required)
coding:snomedctVaccines	Σ	0..1	Coding	Vaccine Code by SNOMED CT Binding: CH VACD Snomed CT for vaccine code (required)
coding:absentOrUnknownImmunization	Σ	0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
text	Σ	0..1	string	Plain text representation of the concept
patient	Σ	1..1	Reference(CH Core Patient)	Patient
encounter		0..1	Reference(CH Core Encounter)	Encounter
Slices for occurrence[x]	Σ	1..1		Vaccine administration date Slice: Unordered, Open by type:$this
occurrenceDateTime			dateTime
occurrenceString			string
occurrence[x]:occurrenceDateTime	SΣ	0..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		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		0..1	date	Vaccine expiration date
site	S	0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route	S	0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
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	SΣ	1..1	Reference(CH Core PractitionerRole)	The performer who applied the vaccine
note	Σ	0..*	Annotation	Additional immunization notes
reasonCode	S	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 imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		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: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
Slices for doseNumber[x]		1..1		Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt			positiveInt
doseNumberString			string
doseNumber[x]:doseNumberPositiveInt	S	0..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	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	extensible	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:swissVaccines	required	SwissVaccines http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-vs
Immunization.vaccineCode.coding:snomedctVaccines	required	SnomedCTForVaccineCode http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-vaccines-snomedct-vs
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	AbsentOrUnknownImmunizationUvIps http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips
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	preferred	RouteOfAdministrationImmunization http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-route-of-administration-vs
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	preferred	ChVacdTargetDiseasesAndIllnessesUndergoneForImmunization http://fhir.ch/ig/ch-vacd/ValueSet/ch-vacd-targetdiseasesandillnessesundergoneforimmunization-vs

Constraints

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

This structure is derived from CHCoreImmunization

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

• CH Core PractitionerRole (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole)

Extensions

This structure refers to these extensions:

• http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
• http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference
• http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Immunization.occurrence[x]
• The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]