Base definition of the Immunization resource for use in Swiss specific use cases.

Vaccine Code Bindings

Default

The CH VACD All Swiss Vaccine Codes ValueSet is the default binding for Immunization.vaccineCode. It includes the code Vaccine product (medicinal product) and two other ValueSets.

The first ValueSet, CH VACD Swissmedic Authorized Vaccine Codes, contains the codes from the CodeSystem CH VACD Swissmedic Authorized Vaccines.

The second ValueSet, CH VACD Old Swiss Vaccine Codes, contains the codes from the CodeSystem CH VACD Old Swiss Vaccines (Swiss Legacy).

The additional code Vaccine product (medicinal product) is included so that a custom vaccination can be defined: use this code as the vaccineCode and specify the diseases the vaccination targets in protocolApplied.targetDisease.

Additional

In some situations a vaccination has to be documented, but no suitable code is available in the default ValueSet (e.g. the product has no Swissmedic authorization, or it is used off-label), while a code does exist in another ValueSet. In these cases, a code from one of the additional ValueSets can be used.

The following ValueSets are defined as additional bindings:

• SNOMED-CT:
  The ValueSet CH VACD Snomed CT for VaccineCode contains the vaccine-related codes from the CodeSystem SNOMED-CT.

• NUVA:
  The ValueSet NUVA contains the codes from the CodeSystem Terminologie - NUVA, which is maintained by the International Vaccine Codes Initiative (IVC). The initiative aims to provide a single, globally unique code system for identifying vaccines, with mappings to the various existing code systems.

Some products authorized by Swissmedic are relevant to immunization but are not vaccines. They are covered by the following two ValueSets:

• Immunoglobulin:
  Immunoglobulins (also known as antibodies or gamma globulins) are specialized Y-shaped proteins produced by B cells and plasma cells. They identify, neutralize and tag foreign invaders such as bacteria and viruses. The ValueSet CH VACD Swissmedic Authorized Immunoglobulin Codes contains the immunoglobulin codes from the CodeSystem CH VACD Swissmedic Authorized Immunoglobulin Codes.

• Immunsera:
  Immune sera are blood serum preparations containing specific antibodies. They are used to provide rapid, passive immunity or to neutralize toxins (e.g. snake antivenom). The ValueSet CH VACD Swissmedic Authorized Immunsera Codes contains the immune serum codes from the CodeSystem CH VACD Swissmedic Authorized Immunsera Codes.

Mappings

The CH Term IG defines several mappings as ConceptMaps. These allow the $tranlate operation to be used to translate a code from one CodeSystem into the corresponding code of another CodeSystem. A graphical overview over the mappings is available in the CH VACD IG.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization	CH Core Immunization
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:recorder		0..1	Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
Immunization.Slices for extension.extension:indicationCode		0..1	string	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD All Swiss Vaccine Codes (preferred) Additional Bindings Purpose Documentation CH VACD Snomed CT for VaccineCode candidate For when SNOMED CT code system is preferred CH VACD Swissmedic Authorized Immunoglobulin Codes candidate For when Swissmedic Immunoglobulin code system is preferred CH VACD Swissmedic Authorized Immunsera Codes candidate For when Swissmedic Immunsera code system is preferred https://smt.esante.gouv.fr/terminologie-nuva?vs candidate For usage of NUVA codes.
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(CH Core Patient)	Patient
Immunization.encounter		0..1	Reference(CH Core Encounter)	Encounter
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1		Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
Immunization.route		0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	preferred	CH VACD All Swiss Vaccine Codes	📦3.4.0	CH Term v3.4
Immunization.route	Base	preferred	CH VACD Route of Administration for Immunization	📦3.4.0	CH Term v3.4

Constraints

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

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization	CH Core Immunization
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:recorder		0..1	Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
Immunization.Slices for extension.extension:indicationCode		0..1	string	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code
Immunization.vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: CH VACD All Swiss Vaccine Codes (preferred) Additional Bindings Purpose Documentation CH VACD Snomed CT for VaccineCode candidate For when SNOMED CT code system is preferred CH VACD Swissmedic Authorized Immunoglobulin Codes candidate For when Swissmedic Immunoglobulin code system is preferred CH VACD Swissmedic Authorized Immunsera Codes candidate For when Swissmedic Immunsera code system is preferred https://smt.esante.gouv.fr/terminologie-nuva?vs candidate For usage of NUVA codes.
Immunization.patient		1..1	Reference(CH Core Patient)	Patient
Immunization.encounter		0..1	Reference(CH Core Encounter)	Encounter
Immunization.route		0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
Immunization.performer
Immunization.performer.actor		1..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	The performer who applied the vaccine
Immunization.protocolApplied
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Immunization.vaccineCode	Base	preferred	CH VACD All Swiss Vaccine Codes	📦3.4.0	CH Term v3.4
Immunization.route	Base	preferred	CH VACD Route of Administration for Immunization	📦3.4.0	CH Term v3.4
Immunization.protocolApplied.​targetDisease	Base	preferred	CH VACD Target disease and illnesses undergone for immunization	📦3.4.0	CH Term v3.4

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization	CH Core Immunization
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Immunization.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained		0..*	Resource	Contained, inline Resources
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:recorder		0..1	Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
Immunization.Slices for extension.extension:indicationCode		0..1	string	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD All Swiss Vaccine Codes (preferred) Additional Bindings Purpose Documentation CH VACD Snomed CT for VaccineCode candidate For when SNOMED CT code system is preferred CH VACD Swissmedic Authorized Immunoglobulin Codes candidate For when Swissmedic Immunoglobulin code system is preferred CH VACD Swissmedic Authorized Immunsera Codes candidate For when Swissmedic Immunsera code system is preferred https://smt.esante.gouv.fr/terminologie-nuva?vs candidate For usage of NUVA codes.
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(CH Core Patient)	Patient
Immunization.encounter		0..1	Reference(CH Core Encounter)	Encounter
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1		Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
Immunization.recorded		0..1	dateTime	When the immunization was first captured in the subject's record
Immunization.primarySource	Σ This element is included in summaries.	0..1	boolean	Indicates context the data was recorded in
Immunization.reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location		0..1	Reference(Location)	Where immunization occurred
Immunization.manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number
Immunization.expirationDate		0..1	date	Vaccine expiration date
Immunization.site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route		0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
Immunization.doseQuantity	C	0..1	SimpleQuantity(4.0.1)	Amount of vaccine administered Constraints: sqty-1
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.performer.id		0..1	string	Unique id for inter-element referencing
Immunization.performer.extension		0..*	Extension	Additional content defined by implementations
Immunization.performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	The performer who applied the vaccine
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes
Immunization.reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Immunization.subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
Immunization.education.id		0..1	string	Unique id for inter-element referencing
Immunization.education.extension		0..*	Extension	Additional content defined by implementations
Immunization.education.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType		0..1	string	Educational material document identifier
Immunization.education.reference		0..1	uri	Educational material reference pointer
Immunization.education.publicationDate		0..1	dateTime	Educational material publication date
Immunization.education.presentationDate		0..1	dateTime	Educational material presentation date
Immunization.programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	Unique id for inter-element referencing
Immunization.reaction.extension		0..*	Extension	Additional content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction
Immunization.protocolApplied		0..*	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.id		0..1	string	Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..*	Extension	Additional content defined by implementations
Immunization.protocolApplied.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series		0..1	string	Name of vaccine series
Immunization.protocolApplied.authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
Immunization.protocolApplied.doseNumber[x]		1..1		Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt			positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString			string
Immunization.protocolApplied.seriesDoses[x]		0..1		Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt			positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	preferred	CH VACD All Swiss Vaccine Codes	📦3.4.0	CH Term v3.4
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📍4.0.1	FHIR Std.
Immunization.site	Base	example	Codes for Immunization Site of Administration	📍4.0.1	FHIR Std.
Immunization.route	Base	preferred	CH VACD Route of Administration for Immunization	📦3.4.0	CH Term v3.4
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📍4.0.1	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📍4.0.1	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📍4.0.1	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📍4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	preferred	CH VACD Target disease and illnesses undergone for immunization	📦3.4.0	CH Term v3.4

Constraints

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization	CH Core Immunization
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:recorder		0..1	Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
Immunization.Slices for extension.extension:indicationCode		0..1	string	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD All Swiss Vaccine Codes (preferred) Additional Bindings Purpose Documentation CH VACD Snomed CT for VaccineCode candidate For when SNOMED CT code system is preferred CH VACD Swissmedic Authorized Immunoglobulin Codes candidate For when Swissmedic Immunoglobulin code system is preferred CH VACD Swissmedic Authorized Immunsera Codes candidate For when Swissmedic Immunsera code system is preferred https://smt.esante.gouv.fr/terminologie-nuva?vs candidate For usage of NUVA codes.
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(CH Core Patient)	Patient
Immunization.encounter		0..1	Reference(CH Core Encounter)	Encounter
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1		Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
Immunization.route		0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	preferred	CH VACD All Swiss Vaccine Codes	📦3.4.0	CH Term v3.4
Immunization.route	Base	preferred	CH VACD Route of Administration for Immunization	📦3.4.0	CH Term v3.4

Constraints

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

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization	CH Core Immunization
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:recorder		0..1	Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
Immunization.Slices for extension.extension:indicationCode		0..1	string	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code
Immunization.vaccineCode		1..1	CodeableConcept	Vaccine product administered Binding: CH VACD All Swiss Vaccine Codes (preferred) Additional Bindings Purpose Documentation CH VACD Snomed CT for VaccineCode candidate For when SNOMED CT code system is preferred CH VACD Swissmedic Authorized Immunoglobulin Codes candidate For when Swissmedic Immunoglobulin code system is preferred CH VACD Swissmedic Authorized Immunsera Codes candidate For when Swissmedic Immunsera code system is preferred https://smt.esante.gouv.fr/terminologie-nuva?vs candidate For usage of NUVA codes.
Immunization.patient		1..1	Reference(CH Core Patient)	Patient
Immunization.encounter		0..1	Reference(CH Core Encounter)	Encounter
Immunization.route		0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
Immunization.performer
Immunization.performer.actor		1..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	The performer who applied the vaccine
Immunization.protocolApplied
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Immunization.vaccineCode	Base	preferred	CH VACD All Swiss Vaccine Codes	📦3.4.0	CH Term v3.4
Immunization.route	Base	preferred	CH VACD Route of Administration for Immunization	📦3.4.0	CH Term v3.4
Immunization.protocolApplied.​targetDisease	Base	preferred	CH VACD Target disease and illnesses undergone for immunization	📦3.4.0	CH Term v3.4

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Immunization		0..*	Immunization	CH Core Immunization
Immunization.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Immunization.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Immunization.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Immunization.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Immunization.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained		0..*	Resource	Contained, inline Resources
Immunization.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:recorder		0..1	Reference(CH Core Patient | CH Core PractitionerRole | CH Core RelatedPerson)	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
Immunization.Slices for extension.extension:indicationCode		0..1	string	Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code
Immunization.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Immunization.identifier		0..*	Identifier	Business identifier
Immunization.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason		0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode	Σ This element is included in summaries.	1..1	CodeableConcept	Vaccine product administered Binding: CH VACD All Swiss Vaccine Codes (preferred) Additional Bindings Purpose Documentation CH VACD Snomed CT for VaccineCode candidate For when SNOMED CT code system is preferred CH VACD Swissmedic Authorized Immunoglobulin Codes candidate For when Swissmedic Immunoglobulin code system is preferred CH VACD Swissmedic Authorized Immunsera Codes candidate For when Swissmedic Immunsera code system is preferred https://smt.esante.gouv.fr/terminologie-nuva?vs candidate For usage of NUVA codes.
Immunization.patient	Σ This element is included in summaries.	1..1	Reference(CH Core Patient)	Patient
Immunization.encounter		0..1	Reference(CH Core Encounter)	Encounter
Immunization.occurrence[x]	Σ This element is included in summaries.	1..1		Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime			dateTime
Immunization.occurrence[x].occurrenceString			string
Immunization.recorded		0..1	dateTime	When the immunization was first captured in the subject's record
Immunization.primarySource	Σ This element is included in summaries.	0..1	boolean	Indicates context the data was recorded in
Immunization.reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location		0..1	Reference(Location)	Where immunization occurred
Immunization.manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
Immunization.lotNumber		0..1	string	Vaccine lot number
Immunization.expirationDate		0..1	date	Vaccine expiration date
Immunization.site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route		0..1	CodeableConcept	How vaccine entered body. Binding: CH VACD Route of Administration for Immunization (preferred)
Immunization.doseQuantity	C	0..1	SimpleQuantity(4.0.1)	Amount of vaccine administered Constraints: sqty-1
Immunization.performer	Σ This element is included in summaries.	0..*	BackboneElement	Who performed event
Immunization.performer.id		0..1	string	Unique id for inter-element referencing
Immunization.performer.extension		0..*	Extension	Additional content defined by implementations
Immunization.performer.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.performer.function	Σ This element is included in summaries.	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor	Σ This element is included in summaries.	1..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Organization)	The performer who applied the vaccine
Immunization.note	Σ This element is included in summaries.	0..*	Annotation	Additional immunization notes
Immunization.reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
Immunization.isSubpotent	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Dose potency
Immunization.subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education	C	0..*	BackboneElement	Educational material presented to patient Constraints: imm-1
Immunization.education.id		0..1	string	Unique id for inter-element referencing
Immunization.education.extension		0..*	Extension	Additional content defined by implementations
Immunization.education.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType		0..1	string	Educational material document identifier
Immunization.education.reference		0..1	uri	Educational material reference pointer
Immunization.education.publicationDate		0..1	dateTime	Educational material publication date
Immunization.education.presentationDate		0..1	dateTime	Educational material presentation date
Immunization.programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction		0..*	BackboneElement	Details of a reaction that follows immunization
Immunization.reaction.id		0..1	string	Unique id for inter-element referencing
Immunization.reaction.extension		0..*	Extension	Additional content defined by implementations
Immunization.reaction.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date		0..1	dateTime	When reaction started
Immunization.reaction.detail		0..1	Reference(Observation)	Additional information on reaction
Immunization.reaction.reported		0..1	boolean	Indicates self-reported reaction
Immunization.protocolApplied		0..*	BackboneElement	Protocol followed by the provider
Immunization.protocolApplied.id		0..1	string	Unique id for inter-element referencing
Immunization.protocolApplied.extension		0..*	Extension	Additional content defined by implementations
Immunization.protocolApplied.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series		0..1	string	Name of vaccine series
Immunization.protocolApplied.authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: CH VACD Target disease and illnesses undergone for immunization (preferred): The code for disease.
Immunization.protocolApplied.doseNumber[x]		1..1		Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt			positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString			string
Immunization.protocolApplied.seriesDoses[x]		0..1		Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt			positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Immunization.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Immunization.status	Base	required	Immunization Status Codes	📍4.0.1	FHIR Std.
Immunization.statusReason	Base	example	Immunization Status Reason Codes	📍4.0.1	FHIR Std.
Immunization.vaccineCode	Base	preferred	CH VACD All Swiss Vaccine Codes	📦3.4.0	CH Term v3.4
Immunization.reportOrigin	Base	example	Immunization Origin Codes	📍4.0.1	FHIR Std.
Immunization.site	Base	example	Codes for Immunization Site of Administration	📍4.0.1	FHIR Std.
Immunization.route	Base	preferred	CH VACD Route of Administration for Immunization	📦3.4.0	CH Term v3.4
Immunization.performer.​function	Base	extensible	Immunization Function Codes	📍4.0.1	FHIR Std.
Immunization.reasonCode	Base	example	Immunization Reason Codes	📍4.0.1	FHIR Std.
Immunization.subpotentReason	Base	example	Immunization Subpotent Reason	📍4.0.1	FHIR Std.
Immunization.programEligibility	Base	example	Immunization Program Eligibility	📍4.0.1	FHIR Std.
Immunization.fundingSource	Base	example	Immunization Funding Source	📍4.0.1	FHIR Std.
Immunization.protocolApplied.​targetDisease	Base	preferred	CH VACD Target disease and illnesses undergone for immunization	📦3.4.0	CH Term v3.4

Constraints

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

This structure is derived from Immunization

Summary

Structures

This structure refers to these other structures:

• CH Core Patient (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient)
• CH Core Encounter (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-encounter)
• CH Core Practitioner (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitioner)
• CH Core PractitionerRole (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-practitionerrole)
• CH Core Organization (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-organization)

Extensions

This structure refers to these extensions:

• http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
• http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-epl-regulated-authorization-limitation-indication-code