Resources: DSTU2: AllergyIntolerance

AllergyIntolerance resource

The AllergyIntolerance resource is used to retrieve a list of adverse reactions to a substance (DAF AllergyIntolerance). The logical ID of the patient is passed as part of the URL. The logical ID is found as the result of a patient search.

To retrieve a list of a patient's adverse reactions, use the following syntax:

GET {FHIR URL}/Patient/{ID}/AllergyIntolerance

Example

To retrieve a list of a patient's adverse reactions reported on January 1, 2016, use the following syntax:

GET {FHIR URL}/Patient/{ID}/AllergyIntolerance?date=eq2016-01-01

Input parameters

Name Required? Type Description
ID Yes URL The patient's logical ID. This is retrieved using the search function.
date No string A string representing a date to include in the search. See below for more information.

Output specification

Name Type Cardinality Description
resourceType AllergyIntolerance
id identifier 0..* Contains the identifier associated with the allergy/intolerance concern that is defined by the business processes and/or used to refer to it when a direct URL reference to the resource is not appropriate. For example, in CDA documents or in written/printed documentation.
meta Metadata about the resource. Returns the profile element which includes a link to the Data Access Framework (DAF) for the AllergyIntolerance resource and the date when it was last updated.
language code 0..1 Base language in which the resource is written. For more information, see here.
text Contains a human-readable version of the structured data, specifically an HTML representation generated by the data layer based on the underlying resource data.
onset dateTime 0..1 Date and/or time of the onset of the allergy or intolerance.
recordedDate dateTime 0..1 Date when the sensitivity was recorded.
recorder Reference (Practitioner, Patient) 0..1 Individual who recorded the allergy and takes responsibility for its content. Options include either DAF-Practitioner profile or DAF-Patient profile.
  • reference: Returns the practitioner ID in the format Practitioner/[ID].
  • display: Returns the practitioner name in the format [Lastname],[Firstname].
patient Reference (Patient) 1..1 Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.
  • reference: Returns the patient ID in the format Patient/[ID].
  • display: Returns the patient name in the format [Lastname],[Firstname].
reporter Reference (Patient, RelatedPerson, Practitioner) 0..1 Source of the information about the allergy that is recorded.
substance CodeableConcept 1..1 Identification of a substance or class of substances that is considered to be responsible for the adverse reaction risk. AllergyIntolerance.substance has an extensible binding to a value set consisting of: NDF-RT (codes for drug class allergies), RXNORM (codes limited to term types- TTY- such as BN or Brand Name, IN or Ingredient, MIN or multiple ingredient, and PIN or precise ingredient for drug ingredient allergies) or SNOMED CT (used when no other code from the other code systems is appropriate, such as No Known Allergies, No Known Food Allergies, No Known Drug Allergies, or No Known Environmental Allergies). For more information on this value set, see: here.
  • system: Returns a link to the coding source.
  • code: Returns the code for the substance.
  • display: Returns the substance display name.
  • text: Returns readable version of the substance name.
status code 0..1 Assertion about certainty associated with the propensity or potential risk of a reaction to the identified substance. The codes shall be taken from the AllergyIntoleranceStatus value set which includes: Active, Unconfirmed, Confirmed, Inactive, Resolved, Refuted, and Entered in Error. 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. Conformance is required and as such, some implementations may choose to make this field mandatory. For more information on this value set, see: here.
criticality code 0..1 Estimate of the potential clinical harm or seriousness of the reaction to the identified substance. The codes shall be taken from the AllergyIntoleranceCriticality value set with required conformance and include: CRITL-Low, CRITH-High, and CRITU-Unable to determine. For more information on this value set, see: here.
type code 0..1 Identification of the underlying physiological mechanism for a reaction risk. This value set includes two types: Allergy or Intolerance. For more information on this value set, see: here.
category code 0..1 Category of the allergy. Options include: Food, Medication, Environment, and Other. For more information on this value set, see: here.
lastOccurence dateTime 0..1 Date and time of the last known occurrence of the reaction.
note Annotation 0..1 Additional text not captured in other fields.
reaction Backbone element 0..* Details about each adverse reaction event linked to exposure to the identified substance. For more information, see here.
-- reaction.substance CodeableConcept 0..1 Identification of the specific substance 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 must be consistent with it. For instance, it may be a more specific substance such as 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. For more information on this value set, see: here.
-- reaction.manifestation CodeableConcept 1..* Clinical symptoms and signs associated with the event. For more information on this value set, see: here.
-- reaction.description string 0..1 Description of the event as a whole.
-- reaction.onset dateTime 0..1 Date and time when manifestations showed.
-- reaction.severity code 0..1 Severity of the reaction or of the event as a whole. Options include: Mild, Moderate, or Severe. For more information on this value set, see: here.
-- reaction.exposureRoute CodeableConcept 0..1 How the subject was exposed to the substance. For more information on this value set, see: here.
-- reaction.note Annotation 0..1 Text about the event not captured in other fields.