This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
This resource maintained by the Patient Care Work Group
Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
A record of a clinical assessment of an Allergy or Intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.
Where a propensity is identified, to record information or evidence about a reaction event that is characterised by any harmful or undesirable, physiological response that is specific to the individual, and triggered by exposure of an individual to the identified substance or class of substance.
Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings.
Note for Reviewers
Presently open issues for this resource:
This resource is used to provide a single place within the health record to document a range of clinical statements about adverse reactions, including:
Use to record information about the positive presence of the risk of an Adverse Reaction:
Use to record information about Adverse Reactions to a broad range of substances, including: biological & blood products; incipients and excipients in medicinal preparations; metal salts; and organic chemical compounds.
Adverse reactions may be:
In clinical practice distinguishing between immune-mediated and non-immune mediated reactions is difficult and often not practical. Identification of the type of reaction is not a proxy for seriousness or risk of harm to the patient, which is better expressed by the manifestation in clinical practice.
The risk of an Adverse Reaction event or manifestation should not be recorded without identifying a proposed causative substance or class of substance. If there is uncertainty that a specific substance is the cause, this uncertainty can be recorded using the 'Status' data element. If there are multiple possible substances that may have caused a reaction/manifestation, each substance should be recorded using a separate instance of this resource with the 'Status' set to an initial state of 'Unconfirmed' so that adverse reaction checking can be supported in clinical systems. If a substance, agent or class is later proven not to be the cause for a given reaction then the 'Status' can be modified to 'Refuted'.
This resource has been designed to allow recording of information about a specific substance (amoxicillin, oysters, or bee sting venom) or, alternatively, a class of substance (eg Penicillins)). If a class of substance is recorded then identification of the exact substance can be recorded on a per exposure basis.
The scope of this FHIR resource has deliberately focused on identifying a pragmatic data set that are used in most clinical systems or will be suitable for most common clinical scenarios; extensions can be used to add additional detail if required. Examples of clinical situations where the extension may be required include: a detailed allergist/immunologist assessment, for reporting to regulatory bodies or use in a clinical trial.
The act of recording any adverse reaction in a health record involves the clinical assessment that a potential hazard exists for an individual if they are exposed to the same substance/agent/class in the future – that is, a relative contraindication - and the default 'Seriousness' value should be set to 'Low'. If a clinician considers that it is not safe for the individual to be deliberately re-exposed to the substance/agent again, for example, following a manifestation of a life-threatening anaphylaxis, then the 'Seriousness' data element should be amended to 'High'.
A formal Adverse Event Report to regulatory bodies is a document that will contain a broad range of information in addition to the specific details about the adverse reaction. The report could utilise parts of this resource plus include additional data as required per jurisdiction.
An Adverse Reaction or Allergy/Intolerance List is a record of all identified propensities for an Adverse Reaction for the individual upon future exposure to the substance or class, plus provides potential access to the evidence provided by details about each reaction event, such as manifestation.
Valuable first-level information that could be presented to the clinician when they need to assess propensity for future reactions are:
Second-level information can be drawn from each exposure event and links to additional detailed information such as history, examination and diagnoses stored elsewhere in the record, if it is available.
Misuse
This resource is referenced by ClinicalImpression, ImmunizationRecommendation, NutritionOrder and Procedure
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | DomainResource | Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance) | ||
identifier | Σ | 0..* | Identifier | External Ids for this item |
recordedDate | Σ | 0..1 | dateTime | When recorded |
recorder | Σ | 0..1 | Practitioner | Patient | Who recorded the sensitivity |
patient | Σ | 1..1 | Patient | Who the sensitivity is for |
reporter | Σ | 0..1 | Patient | RelatedPerson | Practitioner | Source of the information about the allergy |
substance | Σ | 1..1 | CodeableConcept | Substance, (or class) considered to be responsible for risk SubstanceType (Example) |
status | ?! Σ | 0..1 | code | unconfirmed | confirmed | resolved | refuted | entered-in-error AllergyIntoleranceStatus (Required) |
criticality | Σ | 0..1 | code | low | high | unassessible - Estimated potential clinical harm AllergyIntoleranceCriticality (Required) |
type | Σ | 0..1 | code | immune | non-immune - Underlying mechanism (if known) AllergyIntoleranceType (Required) |
category | Σ | 0..1 | code | food | medication | environment - Category of Substance AllergyIntoleranceCategory (Required) |
lastOccurence | Σ | 0..1 | dateTime | Date(/time) of last known occurence of a reaction |
comment | 0..1 | string | Additional text not captured in other fields | |
event | 0..* | Element | Adverse Reaction Events linked to exposure to substance | |
substance | Σ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event SubstanceType (Example) |
certainty | Σ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance AllergyIntoleranceCertainty (Required) |
manifestation | Σ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Manifestation (Example) |
description | 0..1 | string | Description of the event as a whole | |
onset | Σ | 0..1 | dateTime | Date(/time) when manifestations showed |
duration | 0..1 | Duration | How long Manifestations persisted | |
severity | Σ | 0..1 | code | mild | moderate | severe (of event as a whole) AllergyIntoleranceSeverity (Required) |
exposureRoute | Σ | 0..1 | CodeableConcept | How the subject was exposed to the substance RouteOfAdministration (Example) |
comment | 0..1 | string | Text about event not captured in other fields |
UML Diagram
XML Template
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Ids for this item --></identifier> <recordedDate value="[dateTime]"/><!-- 0..1 When recorded --> <recorder><!-- 0..1 Reference(Practitioner|Patient) Who recorded the sensitivity --></recorder> <patient><!-- 1..1 Reference(Patient) Who the sensitivity is for --></patient> <reporter><!-- 0..1 Reference(Patient|RelatedPerson|Practitioner) Source of the information about the allergy --></reporter> <substance><!-- 1..1 CodeableConcept Substance, (or class) considered to be responsible for risk --></substance> <status value="[code]"/><!-- 0..1 unconfirmed | confirmed | resolved | refuted | entered-in-error --> <criticality value="[code]"/><!-- 0..1 low | high | unassessible - Estimated potential clinical harm --> <type value="[code]"/><!-- 0..1 immune | non-immune - Underlying mechanism (if known) --> <category value="[code]"/><!-- 0..1 food | medication | environment - Category of Substance --> <lastOccurence value="[dateTime]"/><!-- 0..1 Date(/time) of last known occurence of a reaction --> <comment value="[string]"/><!-- 0..1 Additional text not captured in other fields --> <event> <!-- 0..* Adverse Reaction Events linked to exposure to substance --> <substance><!-- 0..1 CodeableConcept Specific substance considered to be responsible for event --></substance> <certainty value="[code]"/><!-- 0..1 unlikely | likely | confirmed - clinical certainty about the specific substance --> <manifestation><!-- 1..* CodeableConcept Clinical symptoms/signs associated with the Event --></manifestation> <description value="[string]"/><!-- 0..1 Description of the event as a whole --> <onset value="[dateTime]"/><!-- 0..1 Date(/time) when manifestations showed --> <duration><!-- 0..1 Duration How long Manifestations persisted --></duration> <severity value="[code]"/><!-- 0..1 mild | moderate | severe (of event as a whole) --> <exposureRoute><!-- 0..1 CodeableConcept How the subject was exposed to the substance --></exposureRoute> <comment value="[string]"/><!-- 0..1 Text about event not captured in other fields --> </event> </AllergyIntolerance>
JSON Template
{ "resourceType" : "AllergyIntolerance", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External Ids for this item "recordedDate" : "<dateTime>", // When recorded "recorder" : { Reference(Practitioner|Patient) }, // Who recorded the sensitivity "patient" : { Reference(Patient) }, // R! Who the sensitivity is for "reporter" : { Reference(Patient|RelatedPerson|Practitioner) }, // Source of the information about the allergy "substance" : { CodeableConcept }, // R! Substance, (or class) considered to be responsible for risk "status" : "<code>", // unconfirmed | confirmed | resolved | refuted | entered-in-error "criticality" : "<code>", // low | high | unassessible - Estimated potential clinical harm "type" : "<code>", // immune | non-immune - Underlying mechanism (if known) "category" : "<code>", // food | medication | environment - Category of Substance "lastOccurence" : "<dateTime>", // Date(/time) of last known occurence of a reaction "comment" : "<string>", // Additional text not captured in other fields "event" : [{ // Adverse Reaction Events linked to exposure to substance "substance" : { CodeableConcept }, // Specific substance considered to be responsible for event "certainty" : "<code>", // unlikely | likely | confirmed - clinical certainty about the specific substance "manifestation" : [{ CodeableConcept }], // R! Clinical symptoms/signs associated with the Event "description" : "<string>", // Description of the event as a whole "onset" : "<dateTime>", // Date(/time) when manifestations showed "duration" : { Duration }, // How long Manifestations persisted "severity" : "<code>", // mild | moderate | severe (of event as a whole) "exposureRoute" : { CodeableConcept }, // How the subject was exposed to the substance "comment" : "<string>" // Text about event not captured in other fields }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | DomainResource | Allergy or Intolerance (generally: Risk Of Adverse reaction to a substance) | ||
identifier | Σ | 0..* | Identifier | External Ids for this item |
recordedDate | Σ | 0..1 | dateTime | When recorded |
recorder | Σ | 0..1 | Practitioner | Patient | Who recorded the sensitivity |
patient | Σ | 1..1 | Patient | Who the sensitivity is for |
reporter | Σ | 0..1 | Patient | RelatedPerson | Practitioner | Source of the information about the allergy |
substance | Σ | 1..1 | CodeableConcept | Substance, (or class) considered to be responsible for risk SubstanceType (Example) |
status | ?! Σ | 0..1 | code | unconfirmed | confirmed | resolved | refuted | entered-in-error AllergyIntoleranceStatus (Required) |
criticality | Σ | 0..1 | code | low | high | unassessible - Estimated potential clinical harm AllergyIntoleranceCriticality (Required) |
type | Σ | 0..1 | code | immune | non-immune - Underlying mechanism (if known) AllergyIntoleranceType (Required) |
category | Σ | 0..1 | code | food | medication | environment - Category of Substance AllergyIntoleranceCategory (Required) |
lastOccurence | Σ | 0..1 | dateTime | Date(/time) of last known occurence of a reaction |
comment | 0..1 | string | Additional text not captured in other fields | |
event | 0..* | Element | Adverse Reaction Events linked to exposure to substance | |
substance | Σ | 0..1 | CodeableConcept | Specific substance considered to be responsible for event SubstanceType (Example) |
certainty | Σ | 0..1 | code | unlikely | likely | confirmed - clinical certainty about the specific substance AllergyIntoleranceCertainty (Required) |
manifestation | Σ | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Manifestation (Example) |
description | 0..1 | string | Description of the event as a whole | |
onset | Σ | 0..1 | dateTime | Date(/time) when manifestations showed |
duration | 0..1 | Duration | How long Manifestations persisted | |
severity | Σ | 0..1 | code | mild | moderate | severe (of event as a whole) AllergyIntoleranceSeverity (Required) |
exposureRoute | Σ | 0..1 | CodeableConcept | How the subject was exposed to the substance RouteOfAdministration (Example) |
comment | 0..1 | string | Text about event not captured in other fields |
XML Template
<AllergyIntolerance xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External Ids for this item --></identifier> <recordedDate value="[dateTime]"/><!-- 0..1 When recorded --> <recorder><!-- 0..1 Reference(Practitioner|Patient) Who recorded the sensitivity --></recorder> <patient><!-- 1..1 Reference(Patient) Who the sensitivity is for --></patient> <reporter><!-- 0..1 Reference(Patient|RelatedPerson|Practitioner) Source of the information about the allergy --></reporter> <substance><!-- 1..1 CodeableConcept Substance, (or class) considered to be responsible for risk --></substance> <status value="[code]"/><!-- 0..1 unconfirmed | confirmed | resolved | refuted | entered-in-error --> <criticality value="[code]"/><!-- 0..1 low | high | unassessible - Estimated potential clinical harm --> <type value="[code]"/><!-- 0..1 immune | non-immune - Underlying mechanism (if known) --> <category value="[code]"/><!-- 0..1 food | medication | environment - Category of Substance --> <lastOccurence value="[dateTime]"/><!-- 0..1 Date(/time) of last known occurence of a reaction --> <comment value="[string]"/><!-- 0..1 Additional text not captured in other fields --> <event> <!-- 0..* Adverse Reaction Events linked to exposure to substance --> <substance><!-- 0..1 CodeableConcept Specific substance considered to be responsible for event --></substance> <certainty value="[code]"/><!-- 0..1 unlikely | likely | confirmed - clinical certainty about the specific substance --> <manifestation><!-- 1..* CodeableConcept Clinical symptoms/signs associated with the Event --></manifestation> <description value="[string]"/><!-- 0..1 Description of the event as a whole --> <onset value="[dateTime]"/><!-- 0..1 Date(/time) when manifestations showed --> <duration><!-- 0..1 Duration How long Manifestations persisted --></duration> <severity value="[code]"/><!-- 0..1 mild | moderate | severe (of event as a whole) --> <exposureRoute><!-- 0..1 CodeableConcept How the subject was exposed to the substance --></exposureRoute> <comment value="[string]"/><!-- 0..1 Text about event not captured in other fields --> </event> </AllergyIntolerance>
JSON Template
{ "resourceType" : "AllergyIntolerance", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External Ids for this item "recordedDate" : "<dateTime>", // When recorded "recorder" : { Reference(Practitioner|Patient) }, // Who recorded the sensitivity "patient" : { Reference(Patient) }, // R! Who the sensitivity is for "reporter" : { Reference(Patient|RelatedPerson|Practitioner) }, // Source of the information about the allergy "substance" : { CodeableConcept }, // R! Substance, (or class) considered to be responsible for risk "status" : "<code>", // unconfirmed | confirmed | resolved | refuted | entered-in-error "criticality" : "<code>", // low | high | unassessible - Estimated potential clinical harm "type" : "<code>", // immune | non-immune - Underlying mechanism (if known) "category" : "<code>", // food | medication | environment - Category of Substance "lastOccurence" : "<dateTime>", // Date(/time) of last known occurence of a reaction "comment" : "<string>", // Additional text not captured in other fields "event" : [{ // Adverse Reaction Events linked to exposure to substance "substance" : { CodeableConcept }, // Specific substance considered to be responsible for event "certainty" : "<code>", // unlikely | likely | confirmed - clinical certainty about the specific substance "manifestation" : [{ CodeableConcept }], // R! Clinical symptoms/signs associated with the Event "description" : "<string>", // Description of the event as a whole "onset" : "<dateTime>", // Date(/time) when manifestations showed "duration" : { Duration }, // How long Manifestations persisted "severity" : "<code>", // mild | moderate | severe (of event as a whole) "exposureRoute" : { CodeableConcept }, // How the subject was exposed to the substance "comment" : "<string>" // Text about event not captured in other fields }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)
Path | Definition | Type | Reference |
---|---|---|---|
AllergyIntolerance.substance AllergyIntolerance.event.substance | Type of the substance | Example | http://hl7.org/fhir/vs/substance-type |
AllergyIntolerance.status | Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance | Required | http://hl7.org/fhir/allergy-intolerance-status |
AllergyIntolerance.criticality | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance | Required | http://hl7.org/fhir/allergy-intolerance-criticality |
AllergyIntolerance.type | Identification of the underlying physiological mechanism for a Reaction Risk | Required | http://hl7.org/fhir/allergy-intolerance-type |
AllergyIntolerance.category | Category of an identified Substance | Required | http://hl7.org/fhir/allergy-intolerance-category |
AllergyIntolerance.event.certainty | Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event | Required | http://hl7.org/fhir/reaction-event-certainty |
AllergyIntolerance.event.manifestation | Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event | Example | http://hl7.org/fhir/vs/manifestation-codes |
AllergyIntolerance.event.severity | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations | Required | http://hl7.org/fhir/reaction-event-severity |
AllergyIntolerance.event.exposureRoute | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | Example | http://hl7.org/fhir/vs/route-codes |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
category | token | food | medication | environment - Category of Substance | AllergyIntolerance.category |
criticality | token | low | high | unassessible - Estimated potential clinical harm | AllergyIntolerance.criticality |
date | date | When recorded | AllergyIntolerance.recordedDate |
duration | quantity | How long Manifestations persisted | AllergyIntolerance.event.duration |
identifier | token | External Ids for this item | AllergyIntolerance.identifier |
last-date | date | Date(/time) of last known occurence of a reaction | AllergyIntolerance.lastOccurence |
manifestation | token | Clinical symptoms/signs associated with the Event | AllergyIntolerance.event.manifestation |
onset | date | Date(/time) when manifestations showed | AllergyIntolerance.event.onset |
patient | reference | Who the sensitivity is for | AllergyIntolerance.patient (Patient) |
recorder | reference | Who recorded the sensitivity | AllergyIntolerance.recorder (Patient, Practitioner) |
reporter | reference | Source of the information about the allergy | AllergyIntolerance.reporter (Patient, Practitioner, RelatedPerson) |
route | token | How the subject was exposed to the substance | AllergyIntolerance.event.exposureRoute |
severity | token | mild | moderate | severe (of event as a whole) | AllergyIntolerance.event.severity |
status | token | unconfirmed | confirmed | resolved | refuted | entered-in-error | AllergyIntolerance.status |
substance | token | Substance, (or class) considered to be responsible for risk | AllergyIntolerance.substance, AllergyIntolerance.event.substance |
type | token | immune | non-immune - Underlying mechanism (if known) | AllergyIntolerance.type |