CH eTOC immunizationstatus - CH eTOC (R4) v2.0.1

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..1

Resource

Immunization inline resource

Slices for extension

0..*

Reference(CH VACD Medication For Immunization)

Extension
Slice: Unordered, Open by value:url

recorder

S

0..1

Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson)

Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author

medication

S

0..1

Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference

relatesTo

0..1

(Complex)

Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references

conflict

S

0..*

(Complex)

?!

0..*

Extensions that cannot be ignored

identifier

1..*

Identifier

Immunization item ID

status

?!SΣ

1..1

completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

statusReason

0..1

Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

vaccineCode

SΣ

1..1

Vaccine product administered
Binding: Swissmedic code for vaccine code (extensible)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Slices for coding

Σ

0..*

Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

coding:swissVaccines

Σ

0..1

Swiss Vaccine Code
Binding: Swissmedic code for vaccine code (required)

coding:snomedctVaccines

Σ

0..1

coding:absentOrUnknownImmunization

Vaccine Code by SNOMED CT
Binding: Snomed CT for vaccine code (required)

Σ

0..1

Absent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)

SΣ

0..1

Reference(CH Core Patient)

Plain text representation of the concept

patient

Σ

1..1

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

occurrenceString

occurrence[x]:occurrenceDateTime

SΣ

0..1

Vaccine administration date

recorded

0..1

When the immunization was first captured in the subject's record

primarySource

Σ

0..1

Indicates context the data was recorded in

reportOrigin

0..1

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

Vaccine manufacturer

lotNumber

S

0..1

Vaccine lot number

expirationDate

0..1

Vaccine expiration date

site

S

0..1

Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

route

S

0..1

How vaccine entered body.
Binding: Route of Administration for Immunization (extensible)

doseQuantity

0..1

SimpleQuantity

Amount of vaccine administered

performer

Σ

0..*

Who performed event

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

function

Σ

0..1

Reference(CH Core PractitionerRole)

What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

actor

SΣ

1..1

The performer who applied the vaccine

note

Σ

0..*

Annotation

Additional immunization notes

reasonCode

S

0..*

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

Dose potency

subpotentReason

0..*

Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.

education

C

0..*

Educational material presented to patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

documentType

0..1

Educational material document identifier

reference

0..1

Educational material reference pointer

publicationDate

0..1

Educational material publication date

presentationDate

0..1

Educational material presentation date

programEligibility

0..*

Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.

fundingSource

0..1

Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

reaction

0..*

Details of a reaction that follows immunization

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

When reaction started

detail

0..1

Reference(Observation)

Additional information on reaction

reported

0..1

Indicates self-reported reaction

protocolApplied

1..*

Protocol followed by the provider

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

series

0..1

Name of vaccine series

authority

0..1

Who is responsible for publishing the recommendations

targetDisease

S

1..*

Vaccine preventatable disease being targetted
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

Slices for doseNumber[x]

1..1

Dose number within series
Slice: Unordered, Open by type:$this

doseNumberPositiveInt

doseNumberString

doseNumber[x]:doseNumberPositiveInt

S

0..1

Dose number within series

seriesDoses[x]

0..1

Recommended number of doses for immunity

seriesDosesPositiveInt

seriesDosesString

Documentation for this format

Terminology Bindings

Path

Conformance

ValueSet

Immunization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Immunization.status

ImmunizationStatusCodes

Immunization.statusReason

ImmunizationStatusReasonCodes

Immunization.vaccineCode

Immunization.vaccineCode.coding:swissVaccines

Immunization.vaccineCode.coding:snomedctVaccines

SnomedCTForVaccineCode

Immunization.vaccineCode.coding:absentOrUnknownImmunization

NoImmunizationInfoUvIps

Immunization.reportOrigin

ImmunizationOriginCodes

Immunization.site

CodesForImmunizationSiteOfAdministration

Immunization.route

RouteOfAdministrationImmunization

Immunization.performer.function

ImmunizationFunctionCodes

Immunization.reasonCode

ImmunizationReasonCodes

Immunization.subpotentReason

ImmunizationSubpotentReason

Immunization.programEligibility

ImmunizationProgramEligibility

Immunization.fundingSource

ImmunizationFundingSource

Immunization.protocolApplied.targetDisease

TargetDiseasesAndIllnessesUndergoneForImmunization

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 CHVACDImmunization

Summary

Must-Support: 1 element

Differential View

This structure is derived from CHVACDImmunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHVACDImmunization	CH eTOC immunizationstatus
vaccineCode
text	S	0..1	string	Plain text representation of the concept
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	CHVACDImmunization	CH eTOC immunizationstatus
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..1	Resource	Immunization inline resource
recorder	S	0..1	Reference(CH Core Patient \| CH Core PractitionerRole \| RelatedPerson)	Extension URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author
medication	S	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
relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
conflict	S	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		1..*	Identifier	Immunization item ID
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: 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: Swissmedic code for vaccine code (required)
coding:snomedctVaccines	Σ	0..1	Coding	Vaccine Code by SNOMED CT Binding: Snomed CT for vaccine code (required)
coding:absentOrUnknownImmunization	Σ	0..1	Coding	Absent Unknown Immunization Binding: Absent or Unknown Immunization - IPS (required)
text	SΣ	0..1	string	Plain text representation of the concept
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: Route of Administration for Immunization (extensible)
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		1..*	BackboneElement	Protocol followed by the provider
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
targetDisease	S	1..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: Target disease and illnesses undergone for immunization (extensible): 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Immunization.status	required	ImmunizationStatusCodes
Immunization.vaccineCode	extensible	SwissVaccines
Immunization.vaccineCode.coding:swissVaccines	required	SwissVaccines
Immunization.vaccineCode.coding:snomedctVaccines	required	SnomedCTForVaccineCode
Immunization.vaccineCode.coding:absentOrUnknownImmunization	required	NoImmunizationInfoUvIps
Immunization.site	example	CodesForImmunizationSiteOfAdministration
Immunization.route	extensible	RouteOfAdministrationImmunization
Immunization.reasonCode	example	ImmunizationReasonCodes
Immunization.protocolApplied.targetDisease	extensible	TargetDiseasesAndIllnessesUndergoneForImmunization

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

Description & Constraints

Immunization

0..*

CHVACDImmunization

CH eTOC immunizationstatus

id

Σ

0..1

id

Logical id of this artifact

Meta

Metadata about the resource

implicitRules

?!Σ

0..1

A set of rules under which this content was created

language

0..1

Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional Bindings

Purpose

AllLanguages

Max Binding

0..1

Narrative

Text summary of the resource, for human interpretation

contained

0..1

Resource

Immunization inline resource

Slices for extension

0..*

Reference(CH VACD Medication For Immunization)

Extension
Slice: Unordered, Open by value:url

recorder

S

0..1

Reference(CH Core Patient | CH Core PractitionerRole | RelatedPerson)

Extension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-author

medication

S

0..1

Extension to reference immunization medication resource
URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-immunization-medication-reference

relatesTo

0..1

(Complex)

Entry Resource Cross References
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references

conflict

S

0..*

(Complex)

?!

0..*

Extensions that cannot be ignored

identifier

1..*

Identifier

Immunization item ID

status

?!SΣ

1..1

completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

statusReason

0..1

Reason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

vaccineCode

SΣ

1..1

Vaccine product administered
Binding: Swissmedic code for vaccine code (extensible)

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations
Slice: Unordered, Open by value:url

Slices for coding

Σ

0..*

Code defined by a terminology system
Slice: Unordered, Open by pattern:$this

coding:swissVaccines

Σ

0..1

Swiss Vaccine Code
Binding: Swissmedic code for vaccine code (required)

coding:snomedctVaccines

Σ

0..1

coding:absentOrUnknownImmunization

Vaccine Code by SNOMED CT
Binding: Snomed CT for vaccine code (required)

Σ

0..1

Absent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)

SΣ

0..1

Reference(CH Core Patient)

Plain text representation of the concept

patient

Σ

1..1

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

occurrenceString

occurrence[x]:occurrenceDateTime

SΣ

0..1

Vaccine administration date

recorded

0..1

When the immunization was first captured in the subject's record

primarySource

Σ

0..1

Indicates context the data was recorded in

reportOrigin

0..1

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

Vaccine manufacturer

lotNumber

S

0..1

Vaccine lot number

expirationDate

0..1

Vaccine expiration date

site

S

0..1

Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.

route

S

0..1

How vaccine entered body.
Binding: Route of Administration for Immunization (extensible)

doseQuantity

0..1

SimpleQuantity

Amount of vaccine administered

performer

Σ

0..*

Who performed event

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

function

Σ

0..1

Reference(CH Core PractitionerRole)

What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

actor

SΣ

1..1

The performer who applied the vaccine

note

Σ

0..*

Annotation

Additional immunization notes

reasonCode

S

0..*

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

Dose potency

subpotentReason

0..*

Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.

education

C

0..*

Educational material presented to patient

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

documentType

0..1

Educational material document identifier

reference

0..1

Educational material reference pointer

publicationDate

0..1

Educational material publication date

presentationDate

0..1

Educational material presentation date

programEligibility

0..*

Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.

fundingSource

0..1

Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

reaction

0..*

Details of a reaction that follows immunization

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

0..1

When reaction started

detail

0..1

Reference(Observation)

Additional information on reaction

reported

0..1

Indicates self-reported reaction

protocolApplied

1..*

Protocol followed by the provider

id

0..1

Unique id for inter-element referencing

0..*

Additional content defined by implementations

?!Σ

0..*

Extensions that cannot be ignored even if unrecognized

series

0..1

Name of vaccine series

authority

0..1

Who is responsible for publishing the recommendations

targetDisease

S

1..*

Vaccine preventatable disease being targetted
Binding: Target disease and illnesses undergone for immunization (extensible): The code for disease.

Slices for doseNumber[x]

1..1

Dose number within series
Slice: Unordered, Open by type:$this

doseNumberPositiveInt

doseNumberString

doseNumber[x]:doseNumberPositiveInt

S

0..1

Dose number within series

seriesDoses[x]

0..1

Recommended number of doses for immunity

seriesDosesPositiveInt

seriesDosesString

Documentation for this format

Terminology Bindings

Path

Conformance

ValueSet

Immunization.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

Immunization.status

ImmunizationStatusCodes

Immunization.statusReason

ImmunizationStatusReasonCodes

Immunization.vaccineCode

Immunization.vaccineCode.coding:swissVaccines

Immunization.vaccineCode.coding:snomedctVaccines

SnomedCTForVaccineCode

Immunization.vaccineCode.coding:absentOrUnknownImmunization

NoImmunizationInfoUvIps

Immunization.reportOrigin

ImmunizationOriginCodes

Immunization.site

CodesForImmunizationSiteOfAdministration

Immunization.route

RouteOfAdministrationImmunization

Immunization.performer.function

ImmunizationFunctionCodes

Immunization.reasonCode

ImmunizationReasonCodes

Immunization.subpotentReason

ImmunizationSubpotentReason

Immunization.programEligibility

ImmunizationProgramEligibility

Immunization.fundingSource

ImmunizationFundingSource

Immunization.protocolApplied.targetDisease