Implementation Guide CH VACD, published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-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-vacd/ and changes regularly. See the Directory of published versions

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

Resource Profile: CH VACD AllergyIntolerance

Definition of the AllergyIntolerance part for vaccination record documents.

Usages:

• Use this Profile: CH VACD Immunization Administration Document, CH VACD Vaccination Record Document and CH VACD Message Immunization Recommendation Request
• Refer to this Profile: CH VACD Immunization Administration Composition, CH VACD VaccinationRecord Composition, CH VACD Extension Merging Conflict Entry Reference and CH VACD Immunization Recommendation Request MessageHeader
• Examples for this Profile: AllergyIntolerance/11-1-AllergyIntolerance, AllergyIntolerance/11-2-AllergyIntolerance, AllergyIntolerance/11-3-AllergyIntolerance, AllergyIntolerance/11-4-AllergyIntolerance... Show 4 more, AllergyIntolerance/TCB01-ALLINTO1, AllergyIntolerance/TCF02-ALLINTO1, AllergyIntolerance/TCF02-ALLINTO2 and AllergyIntolerance/TCF02-ALLINTO3

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	CHCoreAllergyIntolerance	CH VACD Recommendation Allergy Intolerance Constraints: ait-1, ait-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
extension: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	AllergyIntolerance item ID
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	1..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.
code	SΣ	0..1	CodeableConcept	Allergy Intolerance code Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.
patient	SΣ	1..1	Reference(CH Core Patient)	Who the sensitivity is for
recorder	S	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson)	Who recorded the sensitivity
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Allergies and Intolerance values for Immunization	📦6.0.0-ci-build	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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 CHCoreAllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	CHCoreAllergyIntolerance	CH VACD Recommendation Allergy Intolerance
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
extension:conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
identifier		1..*	Identifier	AllergyIntolerance item ID
verificationStatus		1..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
code	S	0..1	CodeableConcept	Allergy Intolerance code Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.
patient	S	1..1	Reference(CH Core Patient)	Who the sensitivity is for
recorder	S	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson)	Who recorded the sensitivity
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.code	Base	extensible	Allergies and Intolerance values for Immunization	📦6.0.0-ci-build	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	CHCoreAllergyIntolerance	CH VACD Recommendation Allergy Intolerance Constraints: ait-1, ait-2
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
extension: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	AllergyIntolerance item ID
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	1..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	SΣ	0..1	CodeableConcept	Allergy Intolerance code Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.
patient	SΣ	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	S	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core 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
extension: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.
extension:duration		0..1	Duration	How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
extension:location		0..1	CodeableConcept	Body site of manifestations URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
extension:exposureDate		0..1	dateTime	Date(/time) of first exposure to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
extension:exposureDuration		0..1	Duration	Amount of time individual was exposed to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
extension:exposureDescription		0..1	string	Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
extension: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	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Allergies and Intolerance values for Immunization	📦6.0.0-ci-build	This IG
AllergyIntolerance.reaction.​substance	Base	preferred	CH AllergyIntolerance Reaction Substance	📦3.3.0-ci-build	CH Term v3.3
AllergyIntolerance.reaction.​manifestation	Base	preferred	CH AllergyIntolerance Reaction Manifestation	📦3.3.0-ci-build	CH Term v3.3
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 CHCoreAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	CHCoreAllergyIntolerance	CH VACD Recommendation Allergy Intolerance Constraints: ait-1, ait-2
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
extension: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	AllergyIntolerance item ID
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	1..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.
code	SΣ	0..1	CodeableConcept	Allergy Intolerance code Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.
patient	SΣ	1..1	Reference(CH Core Patient)	Who the sensitivity is for
recorder	S	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson)	Who recorded the sensitivity
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Allergies and Intolerance values for Immunization	📦6.0.0-ci-build	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Differential View

This structure is derived from CHCoreAllergyIntolerance

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance		0..*	CHCoreAllergyIntolerance	CH VACD Recommendation Allergy Intolerance
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
extension:conflict		0..*	(Complex)	Reference to related resource URL: http://fhir.ch/ig/ch-vacd/StructureDefinition/ch-vacd-ext-merging-conflict-entry-reference
identifier		1..*	Identifier	AllergyIntolerance item ID
verificationStatus		1..1	CodeableConcept	unconfirmed | confirmed | refuted | entered-in-error
code	S	0..1	CodeableConcept	Allergy Intolerance code Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.
patient	S	1..1	Reference(CH Core Patient)	Who the sensitivity is for
recorder	S	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson)	Who recorded the sensitivity
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.code	Base	extensible	Allergies and Intolerance values for Immunization	📦6.0.0-ci-build	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AllergyIntolerance	C	0..*	CHCoreAllergyIntolerance	CH VACD Recommendation Allergy Intolerance Constraints: ait-1, ait-2
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:relatesTo		0..1	(Complex)	Entry Resource Cross References URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-ext-entry-resource-cross-references
extension: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	AllergyIntolerance item ID
clinicalStatus	?!ΣC	0..1	CodeableConcept	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	1..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	SΣ	0..1	CodeableConcept	Allergy Intolerance code Binding: Allergies and Intolerance values for Immunization (extensible): The code for allergy.
patient	SΣ	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	S	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(CH Core Practitioner | CH Core PractitionerRole | CH Core Patient | CH Core 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
extension: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.
extension:duration		0..1	Duration	How long Manifestations persisted URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-duration
extension:location		0..1	CodeableConcept	Body site of manifestations URL: http://hl7.org/fhir/StructureDefinition/openEHR-location Binding: SNOMEDCTBodyStructures (extensible): SNOMED CT Body site concepts
extension:exposureDate		0..1	dateTime	Date(/time) of first exposure to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDate
extension:exposureDuration		0..1	Duration	Amount of time individual was exposed to Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDuration
extension:exposureDescription		0..1	string	Text description about exposure to the Substance URL: http://hl7.org/fhir/StructureDefinition/openEHR-exposureDescription
extension: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	Status	Usage	ValueSet	Version	Source
AllergyIntolerance.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
AllergyIntolerance.clinicalStatus	Base	required	AllergyIntolerance Clinical Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.verificationStatus	Base	required	AllergyIntolerance Verification Status Codes	📍4.0.1	FHIR Std.
AllergyIntolerance.type	Base	required	AllergyIntoleranceType	📍4.0.1	FHIR Std.
AllergyIntolerance.category	Base	required	AllergyIntoleranceCategory	📍4.0.1	FHIR Std.
AllergyIntolerance.criticality	Base	required	AllergyIntoleranceCriticality	📍4.0.1	FHIR Std.
AllergyIntolerance.code	Base	extensible	Allergies and Intolerance values for Immunization	📦6.0.0-ci-build	This IG
AllergyIntolerance.reaction.​substance	Base	preferred	CH AllergyIntolerance Reaction Substance	📦3.3.0-ci-build	CH Term v3.3
AllergyIntolerance.reaction.​manifestation	Base	preferred	CH AllergyIntolerance Reaction Manifestation	📦3.3.0-ci-build	CH Term v3.3
AllergyIntolerance.reaction.​severity	Base	required	AllergyIntoleranceSeverity	📍4.0.1	FHIR Std.
AllergyIntolerance.reaction.​exposureRoute	Base	example	SNOMED CT Route Codes	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 CHCoreAllergyIntolerance

Summary

Mandatory: 2 elements
Must-Support: 3 elements

Extensions

This structure refers to these extensions:

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

Other representations of profile: CSV, Excel, Schematron