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 when exposed to a specific substance or class of substance, including information about the adverse reaction. Soarian Clinicals does not differentiate between an allergy and an intolerance. The term allergy is used generically and may overlap with an intolerance. Substances include medications, foods, and environmental allergens (such as plants and animals).

Allergy negation statements for No Known Allergies (NKA), No Known Drug Allergies (NKDA), and No Known Food Allergies (NKFA) are reported using the code element. If a patient has not been asked about their allergies, these statements are conveyed by the absence of information (empty query response). Allergy negation statements for latex and contrast are not coded and are conveyed in the response with the AllergyIntolerance.code.text element as No known latex allergy (situation) or No known contrast allergy (situation).

Soarian Clinicals supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals at the time of the query.

Note:

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

Error: The common Client Errors (for more information, see unresolvable-reference.html) and OperationOutcomes may be returned.

The following fields are returned if valued:

• Allergy ID

• Clinical Status

• Verification Status

• Category (medication, food, environment)

• Allergy Code

• Patient

• Allergy Onset

• Adverse reaction

  • Manifestation

  • Severity

Terminology Bindings

• AllergyIntolerance.clinicalStatus

  Description: The clinical status of the allergy or intolerance.

  Details: AllergyIntolerance Clinical Status Codes

  System: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical

• AllergyIntolerance.verificationStatus

  Description: The assertion about the certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical products).

  Details: AllergyIntolerance Verification Status Codes

  System: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification

• AllergyIntolerance.code

  Description: The code for an allergy statement (a positive or negated statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (for example, Latex), an allergy condition (for example, Latex allergy), or a general or categorical negated statement (for example, No known allergy, No known drug allergies).

  • Details: RxNorm

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

  • Details: SNOMED CT

    System: http://snomed.info/sct

  • Details: Unique Ingredient Identifier (UNII)

    System: https://fdasis.nlm.nih.gov

  • Details: National Drug Data File (FDB Medknowledge)

    System: https://terminology.hl7.org/CodeSystem-nddf.html

• AllergyIntolerance.reaction.manifestation

  Description: The clinical symptoms, signs, or both that are observed or associated with the adverse reaction event.

  Details: SNOMED CT

  System: http://snomed.info/sct

• AllergyIntolerance.reaction.severity

  Description: Clinical assessment of the severity of a reaction event as a whole.

  Details: SNOMED CT

  System: http://hl7.org/fhir/reaction-event-severity

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}