DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

4.1.6 Resource AllergyIntolerance - Detailed Descriptions Resource AllergyIntolerance - Detailed Descriptions Detailed Descriptions for the elements in the AllergyIntolerance resource.

Detailed Descriptions for the elements in the AllergyIntolerance resource.

Control Type code Is Modifier Binding AllergyIntoleranceCriticality: Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance. ( Required ) Comments The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Binding AllergyIntoleranceType: Identification of the underlying physiological mechanism for a Reaction Risk. ( Required ) Binding AllergyIntoleranceCategory: Category of an identified Substance. ( Required ) Alternate Names Category; Type; Reaction Type; Class Comments This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation. © HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
AllergyIntolerance
Definition

Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.

Control 1..1
Requirements

To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance. To record a clinical assessment of a propensity, or potential risk to an individual, of an adverse reaction upon future exposure to the specified substance, or class of substance.

Alternate Names Alternate Names Allergy; Intolerance; Adverse Reaction Allergy; Intolerance; Adverse Reaction
Comments

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

AllergyIntolerance.identifier
Definition

This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Note This is a business identifer, not a resource identifier (see This is a business identifer, not a resource identifier (see discussion )
Control 0..*
Type Identifier
Summary true
AllergyIntolerance.onset AllergyIntolerance.status
Definition

Record of the date and/or time of the onset of the Allergy or Intolerance. Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance.

Control 0..1
Type Binding dateTime AllergyIntoleranceStatus: Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance. ( Required )
Summary Type true code AllergyIntolerance.recordedDate
Definition Is Modifier Date when the sensitivity was recorded. true
Alternate Names 0..1 State
Type Summary dateTime true
Summary Comments true

Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List. Some implementations may choose to make this field mandatory.

AllergyIntolerance.recorder AllergyIntolerance.type
Definition

Individual who recorded the record and takes responsibility for its conten. Identification of the underlying physiological mechanism for the reaction risk.

Control 0..1
Binding AllergyIntoleranceType: Identification of the underlying physiological mechanism for a Reaction Risk. ( Required )
Type Reference ( Practitioner | Patient code )
Alternate Names Alternate Names Author Category; Class
Summary true
Comments

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource.

AllergyIntolerance.patient AllergyIntolerance.category
Definition

The patient who has the allergy or intolerance. Category of the identified Substance.

Control 1..1 0..1
Binding AllergyIntoleranceCategory: Category of an identified Substance. ( Required )
Type Reference ( Patient code )
Alternate Names Alternate Names Patient Category; Type; Reaction Type; Class
Summary true
Comments

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation.

AllergyIntolerance.reporter AllergyIntolerance.criticality
Definition

The source of the information about the allergy that is recorded. Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance.

Control 0..1
Binding AllergyIntoleranceCriticality: Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance. ( Required )
Type Reference ( Patient | RelatedPerson | Practitioner code )
Alternate Names Alternate Names Source; Informant Severity; Seriousness; Contra-indication; Risk
Summary true
Comments

The recorder takes repsonsibility for the content, but can reference the source from where they got it. The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).

AllergyIntolerance.substance
Definition

Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk. Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk.

Control 1..1
Binding AllergyIntolerance Substance and Negation Codes: Type of the substance and Negation codes for reporting no known allergies. ( AllergyIntolerance Substance and Negation Codes: Type of the substance and Negation codes for reporting no known allergies. ( Example )
Type CodeableConcept
Alternate Names Alternate Names Agent
Summary true
Comments

It is strongly recommended that the substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details about a substance can be specified in the text. It is strongly recommended that the substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details about a substance can be specified in the text.

AllergyIntolerance.status AllergyIntolerance.patient
Definition

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance. The patient who has the allergy or intolerance.

Control 0..1 1..1
Binding Type AllergyIntoleranceStatus: Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance. Reference ( Required Patient )
Alternate Names Patient
Summary true
AllergyIntolerance.recordedDate
Definition

Date when the sensitivity was recorded.

true Control Alternate Names State 0..1
Summary Type true dateTime
Comments Summary Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List. Some implementations may choose to make this field mandatory. true
AllergyIntolerance.criticality AllergyIntolerance.recorder
Definition

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance. Individual who recorded the record and takes responsibility for its content.

Control 0..1
Type code Reference ( Practitioner | Patient )
Alternate Names Alternate Names Severity; Seriousness; Contra-indication; Risk Author
Summary true
AllergyIntolerance.type AllergyIntolerance.reporter
Definition

Identification of the underlying physiological mechanism for the reaction risk. The source of the information about the allergy that is recorded.

Control 0..1
Type code Reference ( Patient | RelatedPerson | Practitioner )
Alternate Names Alternate Names Category; Class Source; Informant
Summary true
Comments

Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians may not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts may not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource. The recorder takes repsonsibility for the content, but can reference the source from where they got it.

AllergyIntolerance.category AllergyIntolerance.onset
Definition

Category of the identified Substance. Record of the date and/or time of the onset of the Allergy or Intolerance.

Control 0..1
Type code dateTime
Summary true
AllergyIntolerance.lastOccurence
Definition

Represents the date and/or time of the last known occurrence of a reaction event. Represents the date and/or time of the last known occurrence of a reaction event.

Control 0..1
Type dateTime
Summary true
Comments

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used. This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

AllergyIntolerance.note
Definition

Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

Control 0..1 0..*
Type Annotation
Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes. For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

AllergyIntolerance.reaction
Definition

Details about each adverse reaction event linked to exposure to the identified Substance. Details about each adverse reaction event linked to exposure to the identified Substance.

Control 0..*
AllergyIntolerance.reaction.substance
Definition

Identification of the specific substance considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance. Identification of the specific substance considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different to the substance identified as the cause of the risk, but must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite substance that includes the identified substance. It must be clinically safe to only process the AllergyIntolerance.substance and ignore the AllergyIntolerance.event.substance.

Control 0..1
Binding Substance Code: Codes defining the type of the substance. ( Substance Code: Codes defining the type of the substance. ( Example )
Type CodeableConcept
Summary true
Comments

Coding of the specific substance with a terminology capable of triggering decision support should be used wherever possible. The substance field allows for the use of a specific substance or a group or class of substances, for example "Penicillins". The specific substance field could be used for Amoxycillin. Duplication is acceptable when a specific substance has been recorded in the 'substance' field. Coding of the specific substance with a terminology capable of triggering decision support should be used wherever possible. The substance field allows for the use of a specific substance or a group or class of substances, for example "Penicillins". The specific substance field could be used for Amoxycillin. Duplication is acceptable when a specific substance has been recorded in the 'substance' field.

AllergyIntolerance.reaction.certainty
Definition

Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event. Statement about the degree of clinical certainty that the specific substance was the cause of the manifestation in this reaction event.

Control 0..1
Binding AllergyIntoleranceCertainty: Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event. ( AllergyIntoleranceCertainty: Statement about the degree of clinical certainty that a Specific Substance was the cause of the Manifestation in an reaction event. ( Required )
Type code
Alternate Names Alternate Names Cause
Summary true
AllergyIntolerance.reaction.manifestation
Definition

Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

Control 1..*
Binding SNOMED CT Clinical Findings: Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. ( SNOMED CT Clinical Findings: Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. ( Example )
Type CodeableConcept
Alternate Names Alternate Names Symptoms; Signs Symptoms; Signs
Summary true
Comments

Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10. Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.

AllergyIntolerance.reaction.description
Definition

Text description about the reaction as a whole, including details of the manifestation if required. Text description about the reaction as a whole, including details of the manifestation if required.

Control 0..1
Type string
Alternate Names Alternate Names Narrative; Text Narrative; Text
Comments

Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives. Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives.

AllergyIntolerance.reaction.onset
Definition

Record of the date and/or time of the onset of the Reaction. Record of the date and/or time of the onset of the Reaction.

Control 0..1
Type dateTime
Summary true
AllergyIntolerance.reaction.severity
Definition

Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.

Control 0..1
Binding AllergyIntoleranceSeverity: Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. ( AllergyIntoleranceSeverity: Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. ( Required )
Type code
Summary true
Comments

It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions. It is acknowledged that this assessment is very subjective. There may be some some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions.

AllergyIntolerance.reaction.exposureRoute
Definition

Identification of the route by which the subject was exposed to the substance. Identification of the route by which the subject was exposed to the substance.

Control 0..1
Binding SNOMED CT Route Codes: A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. ( SNOMED CT Route Codes: A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. ( Example )
Type CodeableConcept
Summary true
Comments

Coding of the route of exposure with a terminology should be used wherever possible. Coding of the route of exposure with a terminology should be used wherever possible.

AllergyIntolerance.reaction.note
Definition

Additional text about the adverse reaction event not captured in other fields. Additional text about the adverse reaction event not captured in other fields.

Control 0..1 0..*
Type Annotation
Comments

Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased. Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.