AllergyIntolerance REST Endpoints

Sort by

Task Path Method

Description

AllergyIntolerance

The following topic describes information for the AllergyIntolerance resource.

Overview

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, environment (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.

No Known Allergies (NKA) and No Known Medication Allergies (NKMA) are conveyed with predefined codes while Not Asked is conveyed through the absence of information (empty query response). Consumers can supply the negation codes No Known Allergies 160244002 or No Known Medication Allergies 409137002 as long as the patient's profile contains no other active allergies. If the patient's profile has other active allergies and the consumer tries to add one of the codes above, the service returns an exception.

If NKA, NKMA, or both exist on the patient's allergy profile and a new allergy is added, the NKA and NKMA statuses are canceled.

If the consumer sends information that is deemed a duplicate (codified or free text), the service updates the existing allergy or reaction rather than adding a duplicate allergy or reaction.

With a patient safety or decision support use case, a consumer should avoid querying by status. The status field is not required and can ignore any entered-in-error allergies or intolerances.

The following fields are returned if valued:

• AllergyIntolerance ID

• Allergy substance

• Status

• Patient with allergy/intolerance

• Date of allergy onset

• Date/Time recorded

• Who recorded

• Who reported

• Criticality/potential harm

• Category (medication, food, environment)

• Adverse reaction (clinical symptoms/manifestation)

• Comment

Terminology Bindings

• AllergyIntolerance.substance

  Description: Type of the substance and negation codes for reporting no known allergies.

  • Details: RxNorm

    System: http://www.nlm.nih.gov/research/umls/rxnorm

  • Details: SNOMED CT

    System: http://snomed.info/sct

    SNOMED CT is supported for non-medication substances and for negations.

• AllergyIntolerance.reaction.manifestation

  Description: Clinical symptoms and/or signs that are observed or associated with an adverse reaction event.

  Details: SNOMED CT

  System: http://snomed.info/sct

AllergyIntolerance

The operations from the AllergyIntolerance category.

Create an allergy intolerance

Method: post

Path: /AllergyIntolerance

Get a list of allergy intolerances

Method: get

Path: /AllergyIntolerance

Get an allergy intolerance by ID

Method: get

Path: /AllergyIntolerance/{ID}

Update an allergy intolerance

Method: put

Path: /AllergyIntolerance/{ID}