CH.FHIR.IG.CH-VACD\CH VACD Allergies Section Profile

This page is part of the CH VACD (R4) (v0.1.0: STU 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CH VACD Allergies Section Profile

Defining URL:

http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-section-allergies

Version:

0.1.0

Name:

CHVACDAllergiesSection

Title:

CH VACD Allergies Section Profile

Status:

Draft as of 2021-02-12T16:53:02+01:00

Definition:

Definition of the Allergies part for vaccination record documents.

Publisher:

eHealth Suisse

CC-BY-SA-4.0

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-section-allergies

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

This structure is derived from Observation

Summary

Mandatory: 1 element

This structure is derived from Observation

Name	Card.	Type	Description & Constraints
Observation	0..*	Observation	CH VACD Allergie Observations
extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier	0..*	Identifier	Observation item ID
system	0..1	uri	The namespace for the identifier value
value	0..1	string	The value that is unique
code	1..1	CodeableConcept	Observation code Binding: Allergies for eVACDOC (extensible): The code for allergy.
valueBoolean	1..1	boolean	Observation.valueBoolean
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	CH VACD Allergie Observations
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Observation item ID
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan \| DeviceRequest \| ImmunizationRecommendation \| MedicationRequest \| NutritionOrder \| ServiceRequest)	Fulfills plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration \| MedicationDispense \| MedicationStatement \| Procedure \| Immunization \| ImagingStudy)	Part of referenced event
status	?!Σ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category		0..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	Σ	1..1	CodeableConcept	Observation code Binding: Allergies for eVACDOC (extensible): The code for allergy.
subject	Σ	0..1	Reference(Patient \| Group \| Device \| Location)	Who and/or what the observation is about
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	Σ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation
value[x]	ΣI	1..1	(Slice Definition)	Actual result Slice: Unordered, Closed by type:$this
value[x]:valueBoolean	ΣI	1..1	boolean	Observation.valueBoolean
dataAbsentReason	I	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
bodySite		0..1	CodeableConcept	Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen		0..1	Reference(Specimen)	Specimen used for this observation
device		0..1	Reference(Device \| DeviceMetric)	(Measurement) Device
referenceRange	I	0..*	BackboneElement	Provides guide for interpretation obs-3: Must have at least a low or a high or text
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
low	I	0..1	SimpleQuantity	Low Range, if relevant
high	I	0..1	SimpleQuantity	High Range, if relevant
type		0..1	CodeableConcept	Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo		0..*	CodeableConcept	Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age		0..1	Range	Applicable age range, if relevant
text		0..1	string	Text based reference range in an observation
hasMember	Σ	0..*	Reference(Observation \| QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..*	Reference(DocumentReference \| ImagingStudy \| Media \| QuestionnaireResponse \| Observation \| MolecularSequence)	Related measurements the observation is made from
component	Σ	0..*	BackboneElement	Component results
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
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
value[x]	Σ	0..1		Actual component result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	I	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange		0..*	See referenceRange (Observation)	Provides guide for interpretation of component result
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	CH VACD Allergie Observations
Documentation for this format

This structure is derived from Observation

Summary

Mandatory: 1 element

Differential View

This structure is derived from Observation

Name	Card.	Type	Description & Constraints
Observation	0..*	Observation	CH VACD Allergie Observations
extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
identifier	0..*	Identifier	Observation item ID
system	0..1	uri	The namespace for the identifier value
value	0..1	string	The value that is unique
code	1..1	CodeableConcept	Observation code Binding: Allergies for eVACDOC (extensible): The code for allergy.
valueBoolean	1..1	boolean	Observation.valueBoolean
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Observation	I	0..*	Observation	CH VACD Allergie Observations
id	Σ	0..1	string	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) Max Binding: AllLanguages: A human language.
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Observation item ID
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
basedOn	Σ	0..*	Reference(CarePlan \| DeviceRequest \| ImmunizationRecommendation \| MedicationRequest \| NutritionOrder \| ServiceRequest)	Fulfills plan, proposal or order
partOf	Σ	0..*	Reference(MedicationAdministration \| MedicationDispense \| MedicationStatement \| Procedure \| Immunization \| ImagingStudy)	Part of referenced event
status	?!Σ	1..1	code	registered \| preliminary \| final \| amended + Binding: ObservationStatus (required): Codes providing the status of an observation.
category		0..*	CodeableConcept	Classification of type of observation Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
code	Σ	1..1	CodeableConcept	Observation code Binding: Allergies for eVACDOC (extensible): The code for allergy.
subject	Σ	0..1	Reference(Patient \| Group \| Device \| Location)	Who and/or what the observation is about
focus	Σ	0..*	Reference(Resource)	What the observation is about, when it is not about the subject of record
encounter	Σ	0..1	Reference(Encounter)	Healthcare event during which this observation is made
effective[x]	Σ	0..1		Clinically relevant time/time-period for observation
effectiveDateTime			dateTime
effectivePeriod			Period
effectiveTiming			Timing
effectiveInstant			instant
issued	Σ	0..1	instant	Date/Time this version was made available
performer	Σ	0..*	Reference(Practitioner \| PractitionerRole \| Organization \| CareTeam \| Patient \| RelatedPerson)	Who is responsible for the observation
value[x]	ΣI	1..1	(Slice Definition)	Actual result Slice: Unordered, Closed by type:$this
value[x]:valueBoolean	ΣI	1..1	boolean	Observation.valueBoolean
dataAbsentReason	I	0..1	CodeableConcept	Why the result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
note		0..*	Annotation	Comments about the observation
bodySite		0..1	CodeableConcept	Observed body part Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
method		0..1	CodeableConcept	How it was done Binding: ObservationMethods (example): Methods for simple observations.
specimen		0..1	Reference(Specimen)	Specimen used for this observation
device		0..1	Reference(Device \| DeviceMetric)	(Measurement) Device
referenceRange	I	0..*	BackboneElement	Provides guide for interpretation obs-3: Must have at least a low or a high or text
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
low	I	0..1	SimpleQuantity	Low Range, if relevant
high	I	0..1	SimpleQuantity	High Range, if relevant
type		0..1	CodeableConcept	Reference range qualifier Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
appliesTo		0..*	CodeableConcept	Reference range population Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
age		0..1	Range	Applicable age range, if relevant
text		0..1	string	Text based reference range in an observation
hasMember	Σ	0..*	Reference(Observation \| QuestionnaireResponse \| MolecularSequence)	Related resource that belongs to the Observation group
derivedFrom	Σ	0..*	Reference(DocumentReference \| ImagingStudy \| Media \| QuestionnaireResponse \| Observation \| MolecularSequence)	Related measurements the observation is made from
component	Σ	0..*	BackboneElement	Component results
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
code	Σ	1..1	CodeableConcept	Type of component observation (code / type) Binding: LOINCCodes (example): Codes identifying names of simple observations.
value[x]	Σ	0..1		Actual component result
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueSampledData			SampledData
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
dataAbsentReason	I	0..1	CodeableConcept	Why the component result is missing Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
interpretation		0..*	CodeableConcept	High, low, normal, etc. Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
referenceRange		0..*	See referenceRange (Observation)	Provides guide for interpretation of component result
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Observation.language	preferred	CommonLanguages Max Binding: AllLanguages
Observation.identifier.use	required	IdentifierUse
Observation.identifier.type	extensible	Identifier Type Codes
Observation.status	required	ObservationStatus
Observation.category	preferred	ObservationCategoryCodes
Observation.code	extensible	AllergiesForEvacdoc
Observation.dataAbsentReason	extensible	DataAbsentReason
Observation.interpretation	extensible	ObservationInterpretationCodes
Observation.bodySite	example	SNOMEDCTBodyStructures
Observation.method	example	ObservationMethods
Observation.referenceRange.type	preferred	ObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesTo	example	ObservationReferenceRangeAppliesToCodes
Observation.component.code	example	LOINCCodes
Observation.component.dataAbsentReason	extensible	DataAbsentReason
Observation.component.interpretation	extensible	ObservationInterpretationCodes

Constraints

Id	Path	Details	Requirements
dom-2	Observation	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Observation	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	Observation	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	Observation	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Observation	A resource should have narrative for robust management : text.`div`.exists()
obs-6	Observation	dataAbsentReason SHALL only be present if Observation.value[x] is not present : dataAbsentReason.empty() or value.empty()
obs-7	Observation	If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present : value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
ele-1	Observation.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.identifier.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.identifier.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.identifier.use	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.identifier.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.identifier.system	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.identifier.value	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.identifier.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.identifier.assigner	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.basedOn	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.partOf	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.subject	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.focus	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.encounter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.effective[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.issued	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.value[x]:valueBoolean	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.dataAbsentReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.interpretation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.note	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.bodySite	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.method	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.specimen	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.device	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.referenceRange	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
obs-3	Observation.referenceRange	Must have at least a low or a high or text : low.exists() or high.exists() or text.exists()
ele-1	Observation.referenceRange.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.referenceRange.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.referenceRange.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.referenceRange.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.referenceRange.low	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.referenceRange.high	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.referenceRange.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.referenceRange.appliesTo	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.referenceRange.age	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.referenceRange.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.hasMember	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.derivedFrom	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.component	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.component.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.component.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.component.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Observation.component.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Observation.component.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.component.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.component.dataAbsentReason	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.component.interpretation	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Observation.component.referenceRange	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())