AllergyIntolerance REST Endpoints

Sort by

Task Path Method

Description

AllergyIntolerance

This topic describes information for the AllergyIntolerance resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The AllergyIntolerance resource provides the clinical assessment of a patient's allergy or intolerance when exposed to a specific substance, or class of substance, including information about the adverse reaction. Substances include, but are not limited to, medications, foods, environments (such as plants and animals), and insect bites. The allergy or intolerance list exists as a patient safety tool for clinical decision support when ordering medications and nutrition or guiding clinical treatments.

This resource does not include adverse reactions or adverse events that are expected for the circumstance, such as an overdose or drug-drug interaction, or an error in the clinical process.

References to implicitRules and modifierExtensions are not supported and fail a create or update request.

Profile Support

This resource supports the US Core AllergyIntolerance Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

No Known Allergies and Not Asked Behaviors

• No Known Allergies (NKA) and No Known Medication Allergies (NKMA) are conveyed with predefined codes.
• Not Asked is conveyed through the absence of information (empty query response).
• Consumers can supply the negation codes below if the patient's profile contains no other active allergies. If the profile has other active allergies and one of these codes is added, the service returns an exception.
  • No Known Allergy (situation) (716186003)
  • No Known Medication Allergies (409137002)
• If NKA, NKMA, or both exist and a new allergy is added, the NKA and NKMA statuses are canceled.
• If duplicate information is sent (codified or free text), the service updates the existing allergy or reaction rather than adding a duplicate.
• For patient safety and decision support use cases, avoid querying by status (status is not required and can ignore entered-in-error allergies or intolerances).

Returned Fields

Element	Type
AllergyIntolerance	DomainResource
AllergyIntolerance.clinicalStatus	CodeableConcept
AllergyIntolerance.verificationStatus	CodeableConcept
AllergyIntolerance.code	CodeableConcept
AllergyIntolerance.patient	Reference(Patient)
AllergyIntolerance.reaction	BackboneElement
AllergyIntolerance.reaction.manifestation	CodeableConcept

Terminology Bindings

Element	Description	Details
AllergyIntolerance.clinicalStatus	The clinical status of the allergy or intolerance.	System
AllergyIntolerance.verificationStatus	An assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).	System
AllergyIntolerance.code	The code for an allergy or intolerance statement (a positive or a negated or excluded statement).	RxNorm Substance Code ValueSet SNOMED CT
AllergyIntolerance.reaction.manifestation	The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.	SNOMED CT

AllergyIntolerance

The operations from the AllergyIntolerance category.

Get a list of allergy intolerances

Method: get

Path: /AllergyIntolerance

Get an allergy intolerance by ID

Method: get

Path: /AllergyIntolerance/{id}