This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Patient Care Work Group | Maturity Level: 3 | Trial Use | Security Category: Patient | Compartments: Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the AllergyIntolerance resource.
AllergyIntolerance | |
Element Id | AllergyIntolerance |
Definition | Risk of harmful or undesirable physiological response which is specific to an individual and associated with exposure to a substance. |
Short Display | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) |
Cardinality | 0..* |
Type | DomainResource |
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. |
Alternate Names | Allergy; Intolerance; Adverse Reaction |
Summary | false |
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. |
AllergyIntolerance.identifier | |
Element Id | AllergyIntolerance.identifier |
Definition | Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Short Display | External ids for this item |
Note | This is a business identifier, not a resource identifier (see discussion) |
Cardinality | 0..* |
Type | Identifier |
Requirements | Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers. |
Summary | true |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
AllergyIntolerance.clinicalStatus | |
Element Id | AllergyIntolerance.clinicalStatus |
Definition | The clinical status of the allergy or intolerance. |
Short Display | active | inactive | resolved |
Cardinality | 0..1 |
Terminology Binding | AllergyIntolerance Clinical Status Codes (Required) |
Type | CodeableConcept |
Is Modifier | true (Reason: This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as no longer active.) |
Summary | true |
Comments | AllergyIntolerance.clinicalStatus should be present if verificationStatus is not entered-in-error and the AllergyIntolerance.code isn't negated (No Known Allergy, No Drug Allergy, No Food Allergy, No Latex Allergy). Refer to discussion if clinicalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. |
AllergyIntolerance.verificationStatus | |
Element Id | AllergyIntolerance.verificationStatus |
Definition | Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The verification status pertains to the allergy or intolerance, itself, not to any specific AllergyIntolerance attribute. |
Short Display | unconfirmed | presumed | confirmed | refuted | entered-in-error |
Cardinality | 0..1 |
Terminology Binding | AllergyIntolerance Verification Status (Required) |
Type | CodeableConcept |
Is Modifier | true (Reason: This element is labeled as a modifier because the status contains the codes refuted and entered-in-error that mark the AllergyIntolerance as not currently valid.) |
Summary | true |
Comments | The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. |
AllergyIntolerance.type | |
Element Id | AllergyIntolerance.type |
Definition | Identification of the underlying physiological mechanism for the reaction risk. |
Short Display | allergy | intolerance - Underlying mechanism (if known) |
Cardinality | 0..1 |
Terminology Binding | Allergy Intolerance Type (Preferred) |
Type | CodeableConcept |
Alternate Names | 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 might 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 might 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.category | |
Element Id | AllergyIntolerance.category |
Definition | Category of the identified substance. |
Short Display | food | medication | environment | biologic |
Cardinality | 0..* |
Terminology Binding | Allergy Intolerance Category (Required) |
Type | code |
Alternate Names | 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. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender. |
AllergyIntolerance.criticality | |
Element Id | AllergyIntolerance.criticality |
Definition | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
Short Display | low | high | unable-to-assess |
Cardinality | 0..1 |
Terminology Binding | Allergy Intolerance Criticality (Required) |
Type | code |
Alternate Names | Severity; Seriousness; Contra-indication; Risk |
Summary | true |
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). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent. |
AllergyIntolerance.code | |
Element Id | AllergyIntolerance.code |
Definition | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
Short Display | Code that identifies the allergy or intolerance |
Cardinality | 0..1 |
Terminology Binding | AllergyIntolerance Substance/Product, Condition and Negation Codes (Example) |
Type | CodeableConcept |
Alternate Names | Code |
Summary | true |
Comments | It is strongly recommended that this element be populated using a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNII, and ATC. Plain text should only be used if there is no appropriate terminology available. Additional details can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted. |
AllergyIntolerance.patient | |
Element Id | AllergyIntolerance.patient |
Definition | The patient who has the allergy or intolerance. |
Short Display | Who the allergy or intolerance is for |
Cardinality | 1..1 |
Type | Reference(Patient) |
Alternate Names | Patient |
Summary | true |
AllergyIntolerance.encounter | |
Element Id | AllergyIntolerance.encounter |
Definition | The encounter when the allergy or intolerance was asserted. |
Short Display | Encounter when the allergy or intolerance was asserted |
Cardinality | 0..1 |
Type | Reference(Encounter) |
Summary | false |
AllergyIntolerance.onset[x] | |
Element Id | AllergyIntolerance.onset[x] |
Definition | Estimated or actual date, date-time, or age when allergy or intolerance was identified. |
Short Display | When allergy or intolerance was identified |
Cardinality | 0..1 |
Type | dateTime|Age|Period|Range|string |
[x] Note | See Choice of Datatypes for further information about how to use [x] |
Summary | false |
Comments | Age is generally used when the patient reports an age at which the AllergyIntolerance was noted. Period is generally used to convey an imprecise onset that occurred within the time period. Range is generally used to convey an imprecise age range (e.g. 4 to 6 years old). |
AllergyIntolerance.recordedDate | |
Element Id | AllergyIntolerance.recordedDate |
Definition | The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. |
Short Display | Date allergy or intolerance was first recorded |
Cardinality | 0..1 |
Type | dateTime |
Summary | false |
Comments | When onset date is unknown, recordedDate can be used to establish if the allergy or intolerance was present on or before a given date. If the recordedDate is known and provided by a sending system, it is preferred that the receiving system preserve that recordedDate value. If the recordedDate is not provided by the sending system, the receipt timestamp is sometimes used as the recordedDate. |
AllergyIntolerance.recorder | |
Element Id | AllergyIntolerance.recorder |
Definition | Individual who recorded the record and takes responsibility for its content. |
Short Display | Who recorded the sensitivity |
Cardinality | 0..1 |
Type | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) |
Alternate Names | Author |
Summary | false |
Comments | Because the recorder takes responsibility for accurately recording information in the record, the recorder is the most recent author. The recorder might or might not be the asserter. By contrast, the recordedDate is when the allergy or intolerance was first recorded. |
AllergyIntolerance.asserter | |
Element Id | AllergyIntolerance.asserter |
Definition | The source of the information about the allergy that is recorded. |
Short Display | Source of the information about the allergy |
Cardinality | 0..1 |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
Alternate Names | Source; Informant |
Summary | true |
Comments | The recorder takes responsibility for the content, but can reference the source from where they got it. |
AllergyIntolerance.lastReactionOccurrence | |
Element Id | AllergyIntolerance.lastReactionOccurrence |
Definition | Represents the date and/or time of the last known occurrence of a reaction event. |
Short Display | Date(/time) of last known occurrence of a reaction |
Cardinality | 0..1 |
Type | dateTime |
Summary | false |
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 AllergyIntolerance.note element should be used. |
AllergyIntolerance.note | |
Element Id | AllergyIntolerance.note |
Definition | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. |
Short Display | Additional text not captured in other fields |
Cardinality | 0..* |
Type | Annotation |
Summary | false |
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. |
AllergyIntolerance.reaction | |
Element Id | AllergyIntolerance.reaction |
Definition | Details about each adverse reaction event linked to exposure to the identified substance. |
Short Display | Adverse Reaction Events linked to exposure to substance |
Cardinality | 0..* |
Summary | false |
AllergyIntolerance.reaction.substance | |
Element Id | AllergyIntolerance.reaction.substance |
Definition | Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
Short Display | Specific substance or pharmaceutical product considered to be responsible for event |
Cardinality | 0..1 |
Terminology Binding | Substance Code (Example) |
Type | CodeableConcept |
Summary | false |
Comments | Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'. |
AllergyIntolerance.reaction.manifestation | |
Element Id | AllergyIntolerance.reaction.manifestation |
Definition | Clinical symptoms and/or signs that are observed or associated with the adverse reaction event. |
Short Display | Clinical symptoms/signs associated with the Event |
Cardinality | 1..* |
Terminology Binding | SNOMED CT Clinical Findings (Example) |
Type | CodeableReference(Observation) |
Alternate Names | Symptoms; Signs |
Summary | false |
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. |
AllergyIntolerance.reaction.description | |
Element Id | AllergyIntolerance.reaction.description |
Definition | Text description about the reaction as a whole, including details of the manifestation if required. |
Short Display | Description of the event as a whole |
Cardinality | 0..1 |
Type | string |
Alternate Names | Narrative; Text |
Summary | false |
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 note field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives. |
AllergyIntolerance.reaction.onset | |
Element Id | AllergyIntolerance.reaction.onset |
Definition | Record of the date and/or time of the onset of the Reaction. |
Short Display | Date(/time) when manifestations showed |
Cardinality | 0..1 |
Type | dateTime |
Summary | false |
AllergyIntolerance.reaction.severity | |
Element Id | AllergyIntolerance.reaction.severity |
Definition | Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. |
Short Display | mild | moderate | severe (of event as a whole) |
Cardinality | 0..1 |
Terminology Binding | Allergy Intolerance Severity (Required) |
Type | code |
Summary | false |
Comments | It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions. |
AllergyIntolerance.reaction.exposureRoute | |
Element Id | AllergyIntolerance.reaction.exposureRoute |
Definition | Identification of the route by which the subject was exposed to the substance. |
Short Display | How the subject was exposed to the substance |
Cardinality | 0..1 |
Terminology Binding | SNOMED CT Route Codes (Example) |
Type | CodeableConcept |
Summary | false |
Comments | Coding of the route of exposure with a terminology should be used wherever possible. |
AllergyIntolerance.reaction.note | |
Element Id | AllergyIntolerance.reaction.note |
Definition | Additional text about the adverse reaction event not captured in other fields. |
Short Display | Text about event not captured in other fields |
Cardinality | 0..* |
Type | Annotation |
Summary | false |
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. |