AllergyIntolerance

• Overview
• Terminology Bindings
• Search
  • Authorization Types
  • Parameters
  • Headers
  • Example Search by Patient
  • Example Search by ID
  • Errors
• Retrieve by ID
  • Authorization Types
  • Headers
  • Example
  • Errors

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.

The search results include the following fields if they contain values:

• 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. Details: AllergyIntolerance Clinical Status Codes System: https://terminology.hl7.org/CodeSystem/allergyintolerance-clinical

AllergyIntolerance.verificationStatus

Description An assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). Details: AllergyIntolerance Verification Status Codes System: https://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: https://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 or signs 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

Search

Search for AllergyIntolerance resources that meet the specified query parameters:

GET /AllergyIntolerance?:parameters

Authorization Types

Parameters

Name	Required?	Type	Description
_id	This, or patient	token	The logical resource ID associated with the resource.
patient	This, or _id	reference	The patient who has the allergy.
_revinclude	No	_revinclude	A request to include any Provenance resource in the bundle that refers to an AllergyIntolerance resource in the search results. Only supported with Provenance.

Notes:

• The _revinclude parameter may be provided once with the value Provenance:target. Example: _revinclude=Provenance:target
• When _revinclude is provided in a request, the OAuth2 token must include the patient/Provenance.read system/Provenance.read or user/Provenance.read scope as applicable.

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example Search by Patient

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance?patient=A879904FD2FE4B2D90C89FDA84E1285F

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "69942070-70bb-4ef2-a7b9-260109527317",
  "type": "searchset",
  "timestamp": "2021-03-19T12:22:26-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance/A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "AllergyIntolerance",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073",
        "meta": {
          "lastUpdated": "2020-11-11T20:40:37-05:00"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "category": [
          "medication"
        ],
        "code": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "1191",
              "display": "Aspirin"
            }
          ],
          "text": "aspirin"
        },
        "patient": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "onsetString": "unknown",
        "reaction": [
          {
            "manifestation": [
              {
                "text": "Bleeding"
              }
            ],
            "severity": "severe"
          }
        ],
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Allergy Intolerance</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /> <b>Clinical Status</b>: <b>Code</b>:active <b>Display</b>:Active <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical<br /><b>Verification Status</b>: <b>Code</b>:confirmed <b>Display</b>:Confirmed <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-verification<br /><b>Category</b>:medication<br /><b>Code</b>:<b>Code</b>:1191 <b>Display</b>:Aspirin <b>System</b>:http://www.nlm.nih.gov/research/umls/rxnorm <b>Text</b>:aspirin<br /><b>Onset</b>:unknown<br /><b>Reaction</b>:<b>Text</b>:Bleeding <b>Severity</b>:severe<br /><br /></div>"
        }
      }
    },
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance/A879904FD2FE4B2D90C89FDA84E1285F.ALGIND.NOCON.11212",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "AllergyIntolerance",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.ALGIND.NOCON.11212",
        "meta": {
          "lastUpdated": "2020-11-11T20:40:06-05:00"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "code": {
          "text": "No known contrast allergy (situation)"
        },
        "patient": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Allergy Intolerance</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /> <b>Clinical Status</b>: <b>Code</b>:active <b>Display</b>:Active <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical<br /><b>Verification Status</b>: <b>Code</b>:confirmed <b>Display</b>:Confirmed <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-verification<br /><b>Code</b>: <b>Text</b>:No known contrast allergy (situation)<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

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.

Example Search by ID

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance?_id=A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073

Response

Status: 200 OK

{
  "resourceType": "Bundle",
  "id": "9820b020-9871-4e92-9000-0632a98fd4c9",
  "type": "searchset",
  "timestamp": "2021-09-29T06:58:11-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance/A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073",
      "search": {
        "mode": "match"
      },
      "resource": {
        "resourceType": "AllergyIntolerance",
        "id": "A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073",
        "meta": {
          "lastUpdated": "2020-11-11T20:40:37-05:00"
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "category": [
          "medication"
        ],
        "code": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "1191",
              "display": "Aspirin"
            }
          ],
          "text": "aspirin"
        },
        "patient": {
          "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
          "display": "Mcgovern,Astrid Santiago"
        },
        "onsetString": "unknown",
        "reaction": [
          {
            "manifestation": [
              {
                "text": "Bleeding"
              }
            ],
            "severity": "severe"
          }
        ],
        "text": {
          "status": "generated",
          "div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Allergy Intolerance</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /> <b>Clinical Status</b>: <b>Code</b>:active <b>Display</b>:Active <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical<br /><b>Verification Status</b>: <b>Code</b>:confirmed <b>Display</b>:Confirmed <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-verification<br /><b>Category</b>:medication<br /><b>Code</b>:<b>Code</b>:1191 <b>Display</b>:Aspirin <b>System</b>:http://www.nlm.nih.gov/research/umls/rxnorm <b>Text</b>:aspirin<br /><b>Onset</b>:unknown<br /><b>Reaction</b>:<b>Text</b>:Bleeding <b>Severity</b>:severe<br /><br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance?patient=A879904FD2FE4B2D90C89FDA84E1285F"
    }
  ]
}

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.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by ID

List an individual AllergyIntolerance resource by its ID:

GET /AllergyIntolerance/:id

Authorization Types

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-myrecord-sc.sandboxcerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/AllergyIntolerance/A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073

Response

Status: 200 OK

{
  "resourceType": "AllergyIntolerance",
  "id": "A879904FD2FE4B2D90C89FDA84E1285F.ALG.17073",
  "meta": {
    "lastUpdated": "2020-11-11T20:40:37-05:00"
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ]
  },
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
        "code": "active",
        "display": "Active"
      }
    ]
  },
  "category": [
    "medication"
  ],
  "code": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "1191",
        "display": "Aspirin"
      }
    ],
    "text": "aspirin"
  },
  "patient": {
    "reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
    "display": "Mcgovern,Astrid Santiago"
  },
  "onsetString": "unknown",
  "reaction": [
    {
      "manifestation": [
        {
          "text": "Bleeding"
        }
      ],
      "severity": "severe"
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Allergy Intolerance</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago<br /> <b>Clinical Status</b>: <b>Code</b>:active <b>Display</b>:Active <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical<br /><b>Verification Status</b>: <b>Code</b>:confirmed <b>Display</b>:Confirmed <b>System</b>:http://terminology.hl7.org/CodeSystem/allergyintolerance-verification<br /><b>Category</b>:medication<br /><b>Code</b>:<b>Code</b>:1191 <b>Display</b>:Aspirin <b>System</b>:http://www.nlm.nih.gov/research/umls/rxnorm <b>Text</b>:aspirin<br /><b>Onset</b>:unknown<br /><b>Reaction</b>:<b>Text</b>:Bleeding <b>Severity</b>:severe<br /><br /></div>"
  }
}

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.

Errors

The common errors and OperationOutcomes may be returned.