International Patient Summary Implementation Guide
2.0.0 -

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

## Resource Profile: AllergyIntolerance (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips | Version: 2.0.0
Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | Computable Name: AllergyIntoleranceUvIps

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 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.

Usages:

- Use this Profile: Bundle (IPS)
- Refer to this Profile: Composition (IPS)
- Examples for this Profile: AllergyIntolerance/allergyintolerance-multiple-codings, AllergyIntolerance/allergyintolerance-with-abatement and AllergyIntolerance/eumfh-39-07-1
- CapabilityStatements using this Profile: IPS Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Obligations
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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: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
clinicalStatus | ?!SO Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
code | SO Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
patient | SO Σ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for onset[x] | SO | 0..1 |  | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
onset[x]:onsetDateTime | SO | 0..1 | dateTime | When allergy or intolerance was identified
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reaction | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
manifestation | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
severity | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
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.type | Base | required | AllergyIntoleranceType | 📍4.0.1 | FHIR Std.
AllergyIntolerance.code | Base | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG
AllergyIntolerance.reaction.​manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG
AllergyIntolerance.reaction.​severity | Base | required | AllergyIntoleranceSeverity | 📍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()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:abatement |  | 0..1 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
clinicalStatus | SO | 0..1 | CodeableConceptIPS | active | inactive | resolved
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
verificationStatus |  | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
type | SO | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
code | SO | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
patient | SO | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for onset[x] | SO | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
onset[x]:onsetDateTime | SO | 0..1 | dateTime | When allergy or intolerance was identified
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reaction | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
manifestation | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
AllergyIntolerance.code | Base | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG
AllergyIntolerance.reaction.​manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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: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 | ?!SO Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
patient | SO Σ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
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
Slices for onset[x] | SO | 0..1 |  | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
onset[x]:onsetDateTime | SO | 0..1 | dateTime | When allergy or intolerance was identified
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
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 | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG
AllergyIntolerance.patient.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AllergyIntolerance.reaction.​substance | Base | example | Substance Code | 📍4.0.1 | FHIR Std.
AllergyIntolerance.reaction.​manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG
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()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 2 elements
Must-Support: 10 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|5.3.0-ballot-tc1

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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: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
clinicalStatus | ?!SO Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
code | SO Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
patient | SO Σ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for onset[x] | SO | 0..1 |  | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
onset[x]:onsetDateTime | SO | 0..1 | dateTime | When allergy or intolerance was identified
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reaction | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
manifestation | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
severity | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
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.type | Base | required | AllergyIntoleranceType | 📍4.0.1 | FHIR Std.
AllergyIntolerance.code | Base | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG
AllergyIntolerance.reaction.​manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG
AllergyIntolerance.reaction.​severity | Base | required | AllergyIntoleranceSeverity | 📍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()`

Differential View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
extension:abatement |  | 0..1 | dateTime, Age, Period, Range, string | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
clinicalStatus | SO | 0..1 | CodeableConceptIPS | active | inactive | resolved
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
verificationStatus |  | 0..1 | CodeableConcept | unconfirmed | confirmed | refuted | entered-in-error
type | SO | 0..1 | code | allergy | intolerance - Underlying mechanism (if known)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
code | SO | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
patient | SO | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for onset[x] | SO | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
onset[x]:onsetDateTime | SO | 0..1 | dateTime | When allergy or intolerance was identified
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reaction | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
manifestation | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
severity | SO | 0..1 | code | mild | moderate | severe (of event as a whole)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
AllergyIntolerance.code | Base | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG
AllergyIntolerance.reaction.​manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) 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: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 | ?!SO Σ C | 0..1 | CodeableConceptIPS | active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 1..1 | CodeableConceptIPS | Code that identifies the allergy or intolerance Binding: Allergies & Intolerances - 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
patient | SO Σ | 1..1 | Reference(Patient (IPS)) | Who the sensitivity is for
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
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
Slices for onset[x] | SO | 0..1 |  | When allergy or intolerance was identified Slice: Unordered, Open by type:$this
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
onsetDateTime |  |  | dateTime |
onsetAge |  |  | Age |
onsetPeriod |  |  | Period |
onsetRange |  |  | Range |
onsetString |  |  | string |
onset[x]:onsetDateTime | SO | 0..1 | dateTime | When allergy or intolerance was identified
Obligations | Actor
SHOULD:able-to-populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 0..* | BackboneElement | Adverse Reaction Events linked to exposure to substance
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
description |  | 0..1 | string | Description of the event as a whole
onset |  | 0..1 | dateTime | Date(/time) when manifestations showed
severity | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
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 | preferred | Allergies & Intolerances - IPS | 📦2.0.0 | This IG
AllergyIntolerance.patient.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AllergyIntolerance.reaction.​substance | Base | example | Substance Code | 📍4.0.1 | FHIR Std.
AllergyIntolerance.reaction.​manifestation | Base | preferred | Allergy Reaction - IPS | 📦2.0.0 | This IG
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()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
AllergyIntolerance |  |
Slices for extension |  |
clinicalStatus | SHALL:populate-if-known | SHALL:handle SHOULD:display
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
code | SHALL:populate-if-known | SHALL:handle SHOULD:display
patient | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Slices for onset[x] | SHALL:populate-if-known | SHALL:handle SHOULD:display
onset[x]:onsetDateTime | SHOULD:able-to-populate | SHALL:handle SHOULD:display
reaction | SHALL:populate-if-known | SHALL:handle SHOULD:display
manifestation | SHALL:populate-if-known | SHALL:handle SHOULD:display
severity | SHALL:populate-if-known | SHALL:handle SHOULD:display
Documentation for this format

Summary

Mandatory: 2 elements
Must-Support: 10 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|5.3.0-ballot-tc1

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AllergyIntolerance.onset[x]

Maturity: 3

Other representations of profile: CSV, Excel, Schematron