CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

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

Resource Profile: CH Core AllergyIntolerance

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

Usage:

• Examples for this Resource Profile: AllergyIntolerance/AllergyToCatDander

Formal Views of Profile Content

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

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

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
code		0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CH AllergyIntolerance (preferred)
patient		1..1	Reference(CH Core Patient)	Who the sensitivity is for
recorder		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Who recorded the sensitivity
asserter		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Source of the information about the allergy
reaction
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
certainty		0..1	CodeableConcept	Certainty that the substance was the cause of the manifestation URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
duration		0..1	Duration	How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
location		0..1	CodeableConcept	Body site of manifestations URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
exposureDate		0..1	dateTime	Date(/time) of first exposure to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
exposureDuration		0..1	Duration	Amount of time individual was exposed to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
exposureDescription		0..1	string	Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
management		0..1	string	Clinical Management Description URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: CH AllergyIntolerance Reaction Substance (preferred)
manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: CH AllergyIntolerance Reaction Manifestation (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.code	preferred	CHAllergyIntoleranceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceValueSet
AllergyIntolerance.reaction.substance	preferred	CHAllergyIntoleranceReactionSubstanceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestation	preferred	CHAllergyIntoleranceReactionManifestationValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionManifestationValueSet

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CH AllergyIntolerance (preferred) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(CH Core Patient)	Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
recorder		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children
asserter	Σ	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Source of the information about the allergy ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.code	preferred	CHAllergyIntoleranceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceValueSet

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	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	AllergyIntolerance	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	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	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
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	Σ	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CH AllergyIntolerance (preferred)
patient	Σ	1..1	Reference(CH Core Patient)	Who the sensitivity is for
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]		0..1		When allergy or intolerance was identified
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Source of the information about the allergy
lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
note		0..*	Annotation	Additional text not captured in other fields
reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
certainty		0..1	CodeableConcept	Certainty that the substance was the cause of the manifestation URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
duration		0..1	Duration	How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
location		0..1	CodeableConcept	Body site of manifestations URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
exposureDate		0..1	dateTime	Date(/time) of first exposure to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
exposureDuration		0..1	Duration	Amount of time individual was exposed to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
exposureDescription		0..1	string	Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
management		0..1	string	Clinical Management Description URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: CH AllergyIntolerance Reaction Substance (preferred)
manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: CH AllergyIntolerance Reaction Manifestation (preferred)
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	preferred	CHAllergyIntoleranceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceValueSet
AllergyIntolerance.reaction.substance	preferred	CHAllergyIntoleranceReactionSubstanceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestation	preferred	CHAllergyIntoleranceReactionManifestationValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionManifestationValueSet
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	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	AllergyIntolerance	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	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	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 AllergyIntolerance

Summary

Structures

This structure refers to these other structures:

• CH Core Patient (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient)
• 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)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
• http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
• http://hl7.org/fhir/StructureDefinition/openEHR-location
• http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
• http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
• http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
• http://hl7.org/fhir/StructureDefinition/openEHR-management

Differential View

This structure is derived from AllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
code		0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CH AllergyIntolerance (preferred)
patient		1..1	Reference(CH Core Patient)	Who the sensitivity is for
recorder		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Who recorded the sensitivity
asserter		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Source of the information about the allergy
reaction
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
certainty		0..1	CodeableConcept	Certainty that the substance was the cause of the manifestation URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
duration		0..1	Duration	How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
location		0..1	CodeableConcept	Body site of manifestations URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
exposureDate		0..1	dateTime	Date(/time) of first exposure to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
exposureDuration		0..1	Duration	Amount of time individual was exposed to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
exposureDescription		0..1	string	Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
management		0..1	string	Clinical Management Description URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: CH AllergyIntolerance Reaction Substance (preferred)
manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: CH AllergyIntolerance Reaction Manifestation (preferred)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.code	preferred	CHAllergyIntoleranceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceValueSet
AllergyIntolerance.reaction.substance	preferred	CHAllergyIntoleranceReactionSubstanceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestation	preferred	CHAllergyIntoleranceReactionManifestationValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionManifestationValueSet

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. ele-1: All FHIR elements must have a @value or children
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CH AllergyIntolerance (preferred) ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(CH Core Patient)	Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
recorder		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children
asserter	Σ	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Source of the information about the allergy ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.code	preferred	CHAllergyIntoleranceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceValueSet

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	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	AllergyIntolerance	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	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	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
AllergyIntolerance	C	0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
type	Σ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
category	Σ	0..*	code	food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
criticality	Σ	0..1	code	low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
code	Σ	0..1	CodeableConcept	Code that identifies the allergy or intolerance Binding: CH AllergyIntolerance (preferred)
patient	Σ	1..1	Reference(CH Core Patient)	Who the sensitivity is for
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]		0..1		When allergy or intolerance was identified
onsetDateTime			dateTime
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
recordedDate		0..1	dateTime	Date first version of the resource instance was recorded
recorder		0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | RelatedPerson)	Source of the information about the allergy
lastOccurrence		0..1	dateTime	Date(/time) of last known occurrence of a reaction
note		0..*	Annotation	Additional text not captured in other fields
reaction		0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
certainty		0..1	CodeableConcept	Certainty that the substance was the cause of the manifestation URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty Binding: AllergyIntoleranceCertainty (extensible): Statement about the degree of clinical certainty that a specific substance was the cause of the manifestation in a reaction event.
duration		0..1	Duration	How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
location		0..1	CodeableConcept	Body site of manifestations URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
exposureDate		0..1	dateTime	Date(/time) of first exposure to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
exposureDuration		0..1	Duration	Amount of time individual was exposed to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
exposureDescription		0..1	string	Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
management		0..1	string	Clinical Management Description URL: http://hl7.org/fhir/StructureDefinition/openEHR-management
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: CH AllergyIntolerance Reaction Substance (preferred)
manifestation		1..*	CodeableConcept	Clinical symptoms/signs associated with the Event Binding: CH AllergyIntolerance Reaction Manifestation (preferred)
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity		0..1	code	mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
exposureRoute		0..1	CodeableConcept	How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
note		0..*	Annotation	Text about event not captured in other fields
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AllergyIntolerance.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AllergyIntolerance.clinicalStatus	required	AllergyIntoleranceClinicalStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1 from the FHIR Standard
AllergyIntolerance.verificationStatus	required	AllergyIntoleranceVerificationStatusCodes http://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1 from the FHIR Standard
AllergyIntolerance.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.category	required	AllergyIntoleranceCategory http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1 from the FHIR Standard
AllergyIntolerance.criticality	required	AllergyIntoleranceCriticality http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1 from the FHIR Standard
AllergyIntolerance.code	preferred	CHAllergyIntoleranceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceValueSet
AllergyIntolerance.reaction.substance	preferred	CHAllergyIntoleranceReactionSubstanceValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionSubstanceValueSet
AllergyIntolerance.reaction.manifestation	preferred	CHAllergyIntoleranceReactionManifestationValueSet http://fhir.ch/ig/ch-allergyintolerance/ValueSet/CHAllergyIntoleranceReactionManifestationValueSet
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 from the FHIR Standard
AllergyIntolerance.reaction.exposureRoute	example	SNOMEDCTRouteCodes http://hl7.org/fhir/ValueSet/route-codes from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ait-1	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2	error	AllergyIntolerance	AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2	error	AllergyIntolerance	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AllergyIntolerance	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	AllergyIntolerance	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	AllergyIntolerance	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AllergyIntolerance	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 AllergyIntolerance

Summary

Structures

This structure refers to these other structures:

• CH Core Patient (http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-patient)
• 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)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/allergyintolerance-certainty
• http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
• http://hl7.org/fhir/StructureDefinition/openEHR-location
• http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
• http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
• http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
• http://hl7.org/fhir/StructureDefinition/openEHR-management

Other representations of profile: CSV, Excel, Schematron