International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

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

Resource Profile: AllergyIntolerance (IPS)

This profile represents the constraints applied to the AllergyIntolerance resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile.

It documents the relevant allergies or intolerances (conditions) for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy.

This profile constrains the representation of a record of an allergy or intolerance of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.

Usage:

• Use this Resource Profile: Bundle (IPS)
• Refer to this Resource Profile: Composition (IPS)

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
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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
abatement		0..1	dateTime, Age, Period, Range, string	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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	CodeableConceptIPS	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	CodeableConceptIPS	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
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children
code	SΣ	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose WHO ATC - IPS candidate ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(Patient (IPS))	Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
onset[x]	S	0..1		When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
onsetDateTime			dateTime
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
manifestation	S	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT. ele-1: All FHIR elements must have a @value or children
severity	S	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. 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.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.code	preferred	AllergyIntoleranceUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips from this IG
AllergyIntolerance.reaction.manifestation	preferred	AllergyReactionUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips from this IG
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 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

Name	Flags	Card.	Type	Description & Constraints
AllergyIntolerance		0..*	AllergyIntolerance	Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
abatement		0..1	dateTime, Age, Period, Range, string	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
clinicalStatus		0..1	CodeableConceptIPS	active | inactive | resolved
verificationStatus		0..1	CodeableConceptIPS	unconfirmed | confirmed | refuted | entered-in-error
type	S	0..1	code	allergy | intolerance - Underlying mechanism (if known)
code	S	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose WHO ATC - IPS candidate
patient	S	1..1	Reference(Patient (IPS))	Who the sensitivity is for
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
onset[x]	S	0..1		When allergy or intolerance was identified
onsetDateTime			dateTime S
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
manifestation	S	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
severity	S	0..1	code	mild | moderate | severe (of event as a whole)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.code	preferred	AllergyIntoleranceUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips from this IG
AllergyIntolerance.reaction.manifestation	preferred	AllergyReactionUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips from this IG

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
abatement		0..1	dateTime, Age, Period, Range, string	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConceptIPS	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConceptIPS	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	SΣ	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Σ	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose WHO ATC - IPS candidate
patient	SΣ	1..1	Reference(Patient (IPS))	Who the sensitivity is for
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]	S	0..1		When allergy or intolerance was identified
onsetDateTime			dateTime S
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(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	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	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
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
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation	S	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity	S	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	AllergyIntoleranceUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips from this IG
AllergyIntolerance.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	preferred	AllergyReactionUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips from this IG
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

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement

Maturity: 2

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
abatement		0..1	dateTime, Age, Period, Range, string	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
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	CodeableConceptIPS	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	CodeableConceptIPS	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
type	SΣ	0..1	code	allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. ele-1: All FHIR elements must have a @value or children
code	SΣ	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose WHO ATC - IPS candidate ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(Patient (IPS))	Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children
onset[x]	S	0..1		When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
onsetDateTime			dateTime
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
manifestation	S	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT. ele-1: All FHIR elements must have a @value or children
severity	S	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. 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.type	required	AllergyIntoleranceType http://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1 from the FHIR Standard
AllergyIntolerance.code	preferred	AllergyIntoleranceUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips from this IG
AllergyIntolerance.reaction.manifestation	preferred	AllergyReactionUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips from this IG
AllergyIntolerance.reaction.severity	required	AllergyIntoleranceSeverity http://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1 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()

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)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
abatement		0..1	dateTime, Age, Period, Range, string	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
clinicalStatus		0..1	CodeableConceptIPS	active | inactive | resolved
verificationStatus		0..1	CodeableConceptIPS	unconfirmed | confirmed | refuted | entered-in-error
type	S	0..1	code	allergy | intolerance - Underlying mechanism (if known)
code	S	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose WHO ATC - IPS candidate
patient	S	1..1	Reference(Patient (IPS))	Who the sensitivity is for
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
onset[x]	S	0..1		When allergy or intolerance was identified
onsetDateTime			dateTime S
onsetAge			Age
onsetPeriod			Period
onsetRange			Range
onsetString			string
reaction	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
manifestation	S	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
severity	S	0..1	code	mild | moderate | severe (of event as a whole)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AllergyIntolerance.code	preferred	AllergyIntoleranceUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips from this IG
AllergyIntolerance.reaction.manifestation	preferred	AllergyReactionUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips from this IG

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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
abatement		0..1	dateTime, Age, Period, Range, string	When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	External ids for this item
clinicalStatus	?!ΣC	0..1	CodeableConceptIPS	active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
verificationStatus	?!ΣC	0..1	CodeableConceptIPS	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	SΣ	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Σ	1..1	CodeableConceptIPS	Code that identifies the allergy or intolerance Binding: Allergy Intolerance - IPS (preferred): Type of the substance/product, allergy or intolerance condition or a code for absent/unknown allergy. Additional Bindings Purpose WHO ATC - IPS candidate
patient	SΣ	1..1	Reference(Patient (IPS))	Who the sensitivity is for
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
encounter		0..1	Reference(Encounter)	Encounter when the allergy or intolerance was asserted
onset[x]	S	0..1		When allergy or intolerance was identified
onsetDateTime			dateTime S
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(Practitioner | PractitionerRole | Patient | RelatedPerson)	Who recorded the sensitivity
asserter	Σ	0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole)	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	S	0..*	BackboneElement	Adverse Reaction Events linked to exposure to substance
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
substance		0..1	CodeableConcept	Specific substance or pharmaceutical product considered to be responsible for event Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
manifestation	S	1..*	CodeableConceptIPS	Clinical symptoms/signs associated with the Event Binding: Allergy Reaction - IPS (preferred): Code for the allergy or intolerance reaction manifestation from SNOMED CT.
description		0..1	string	Description of the event as a whole
onset		0..1	dateTime	Date(/time) when manifestations showed
severity	S	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	AllergyIntoleranceUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-uv-ips from this IG
AllergyIntolerance.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
AllergyIntolerance.reaction.substance	example	SubstanceCode http://hl7.org/fhir/ValueSet/substance-code from the FHIR Standard
AllergyIntolerance.reaction.manifestation	preferred	AllergyReactionUvIps http://hl7.org/fhir/uv/ips/ValueSet/allergy-reaction-uv-ips from this IG
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

Mandatory: 2 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
• Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement

Maturity: 2

Other representations of profile: CSV, Excel, Schematron