NAV Navbar
Logo cerner
Ruby Shell

Allergy API v1

The HealtheIntent Allergy API allows systems to interact with allergy data in HealtheIntent.

Note: The data retrieved by this API is filtered based on your sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us.healtheintent.com/allergy/v1

Allergy

An allergy represents a potential risk of a patient to have an adverse reaction to a specified allergen. An allergen can be a food substance, an environmental substance, a biologic substance, a medication substance, a pharmaceutical product, or a class of substances (such as penicillins). Negation of an allergen can be holistic (No Known Allergies), per category (No Known Drug Allergies), or per substance (No Known Latex Allergy).

Retrieve a Single Allergy

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/allergy/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergies/9223352518230775807ce96771ac0b23280f02a89e1e3a6a72a28e17df3b94b1ffc7951c65c67c016f2', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/allergy/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergies/9223352518230775807ce96771ac0b23280f02a89e1e3a6a72a28e17df3b94b1ffc7951c65c67c016f2 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "assertedOn": "2018-04-01T13:21:12.123Z",
  "asserter": {
    "provider": {
      "aliases": [
        {
          "type": "DEA"
        }
      ],
      "name": {
        "prefix": "Dr.",
        "given": [
          "Jane",
          "Susannah"
        ],
        "family": [
          "Smith"
        ],
        "suffix": "MD.",
        "formatted": "Dr. Jane Susannah Smith MD."
      }
    },
    "providerRoles": [
      {
        "sourceCodings": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
            "code": "doctor",
            "display": "Doctor"
          }
        ],
        "codings": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
            "code": "doctor",
            "display": "Doctor"
          }
        ],
        "text": "Doctor"
      }
    ],
    "type": "PROVIDER"
  },
  "category": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "416098002",
        "display": "Drug allergy (disorder)"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "416098002",
        "display": "Drug allergy (disorder)"
      }
    ],
    "text": "Drug allergy (disorder)"
  },
  "code": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.69",
        "code": "66267099120",
        "display": "Augmentin"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.69",
        "code": "6267099120",
        "display": "Augmentin 875 mg-125 mg oral tablet"
      },
      {
        "system": "2.16.840.1.113883.6.69",
        "code": "PENICILLINS_MED",
        "display": "penicillin"
      },
      {
        "system": "2.16.840.1.113883.6.69",
        "code": "BETA_LACTAMASE_INHIBITORS_MED",
        "display": "beta lactamase inhibitors"
      }
    ],
    "text": "Augmentin"
  },
  "criticality": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "62482003",
        "display": "Low"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "62482003",
        "display": "Low"
      }
    ],
    "text": "Low"
  },
  "encounter": {
    "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
  },
  "id": "9223352518230775807ce96771ac0b23280f02a89e1e3a6a72a28e17df3b94b1ffc7951c65c67c016f2",
  "notes": [
    {
      "author": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.814",
            "type": "DEA",
            "value": "1234"
          }
        ],
        "name": {
          "given": [],
          "family": [],
          "formatted": "Brizendine, Margaret"
        }
      },
      "date": "2018-04-06T20:04:16.243Z",
      "text": "The patient is feeling well today."
    }
  ],
  "onset": "2018-04-01T13:21:12.123Z",
  "reactions": [
    {
      "reaction": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "271807003",
            "display": "Rash"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "271807003",
            "display": "Skin rash"
          }
        ],
        "text": "Skin rash"
      },
      "severity": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "6736007",
            "display": "Moderate"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "6736007",
            "display": "Moderate (severity modifier) (qualifier value)"
          }
        ],
        "text": "Moderate"
      }
    }
  ],
  "resolvedOn": "2018-04-07T16:01:12.323Z",
  "sourceIdentifier": {
    "dataPartitionId": "99f31909-5b3b-4560-8c83-627828b2c97d",
    "id": "1708574400011"
  },
  "status": {
    "sourceCodings": [
      {
        "system": "vendor:allergystatus",
        "code": "1",
        "display": "Active"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "55561003",
        "display": "Active"
      }
    ],
    "text": "Active"
  },
  "type": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:12021",
        "code": "638974",
        "display": "Allergy"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "609328004",
        "display": "Allergic disposition"
      }
    ],
    "text": "Allergy"
  }
}

GET /populations/{populationId}/patients/{patientId}/allergies/{allergyId}

Retrieves a single allergy for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The identifier of the population. -
patientId path string true N/A The identifier of the patient. -
allergyId path string true N/A The ID that uniquely identifies the allergy for the patient. -

Response Statuses

Status Meaning Description Schema
200 OK OK Allergy
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Retrieve a List of Allergies

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us.healtheintent.com/allergy/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergies', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/allergy/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergies \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "assertedOn": "2018-04-01T13:21:12.123Z",
      "asserter": {
        "provider": {
          "aliases": [
            {
              "type": "DEA"
            }
          ],
          "name": {
            "prefix": "Dr.",
            "given": [
              "Jane",
              "Susannah"
            ],
            "family": [
              "Smith"
            ],
            "suffix": "MD.",
            "formatted": "Dr. Jane Susannah Smith MD."
          }
        },
        "providerRoles": [
          {
            "sourceCodings": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
                "code": "doctor",
                "display": "Doctor"
              }
            ],
            "codings": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/practitioner-role",
                "code": "doctor",
                "display": "Doctor"
              }
            ],
            "text": "Doctor"
          }
        ],
        "type": "PROVIDER"
      },
      "category": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "416098002",
            "display": "Drug allergy (disorder)"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "416098002",
            "display": "Drug allergy (disorder)"
          }
        ],
        "text": "Drug allergy (disorder)"
      },
      "code": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.69",
            "code": "66267099120",
            "display": "Augmentin"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.69",
            "code": "6267099120",
            "display": "Augmentin 875 mg-125 mg oral tablet"
          },
          {
            "system": "2.16.840.1.113883.6.69",
            "code": "PENICILLINS_MED",
            "display": "penicillin"
          },
          {
            "system": "2.16.840.1.113883.6.69",
            "code": "BETA_LACTAMASE_INHIBITORS_MED",
            "display": "beta lactamase inhibitors"
          }
        ],
        "text": "Augmentin"
      },
      "criticality": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "62482003",
            "display": "Low"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "62482003",
            "display": "Low"
          }
        ],
        "text": "Low"
      },
      "encounter": {
        "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
      },
      "id": "9223352518230775807ce96771ac0b23280f02a89e1e3a6a72a28e17df3b94b1ffc7951c65c67c016f2",
      "notes": [
        {
          "author": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.814",
                "type": "DEA",
                "value": "1234"
              }
            ],
            "name": {
              "given": [],
              "family": [],
              "formatted": "Brizendine, Margaret"
            }
          },
          "date": "2018-04-06T20:04:16.243Z",
          "text": "The patient is feeling well today."
        }
      ],
      "onset": "2018-04-01T13:21:12.123Z",
      "reactions": [
        {
          "reaction": {
            "sourceCodings": [
              {
                "system": "2.16.840.1.113883.6.96",
                "code": "271807003",
                "display": "Rash"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.6.96",
                "code": "271807003",
                "display": "Skin rash"
              }
            ],
            "text": "Skin rash"
          },
          "severity": {
            "sourceCodings": [
              {
                "system": "2.16.840.1.113883.6.96",
                "code": "6736007",
                "display": "Moderate"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.6.96",
                "code": "6736007",
                "display": "Moderate (severity modifier) (qualifier value)"
              }
            ],
            "text": "Moderate"
          }
        }
      ],
      "resolvedOn": "2018-04-07T16:01:12.323Z",
      "sourceIdentifier": {
        "dataPartitionId": "99f31909-5b3b-4560-8c83-627828b2c97d",
        "id": "1708574400011"
      },
      "status": {
        "sourceCodings": [
          {
            "system": "vendor:allergystatus",
            "code": "1",
            "display": "Active"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "55561003",
            "display": "Active"
          }
        ],
        "text": "Active"
      },
      "type": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:12021",
            "code": "638974",
            "display": "Allergy"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "609328004",
            "display": "Allergic disposition"
          }
        ],
        "text": "Allergy"
      }
    }
  ],
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/allergy/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergies?limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/allergy/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/allergies?cursor=9223352518230775807ce96771ac0b23280f02a89e1e3a6a72a28e17df3b94b1ffc7951c65c67c016f2&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/allergies

Retrieves a list of the allergies for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The identifier of the population. -
patientId path string true N/A The identifier of the patient. -
cursor query string false N/A The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK Allergies
400 Bad Request Bad request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not found Error

Schema Definitions

Allergy

Name Type Required Description Accepted Values
assertedOn string false The date when the allergy was first acknowledged and recorded in the system. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
asserter Asserter false The source of the information about the allergy that is recorded. -
category CodeableConcept false The category or type of allergy, such as drug, food, or environmental. -
code CodeableConcept false Describes the allergen, or a negation of an allergen, and its categories using text or codified values. An allergen can be a food substance, an environmental substance, a biologic substance, a medication substance, a pharmaceutical product, or a class of substances (such as penicillins). Negation of an allergen can be holistic (No Known Allergies), per category (No Known Drug Allergies), or per substance (No Known Latex Allergy). -
criticality CodeableConcept false The potential seriousness of a future reaction. This represents a clinical judgment about the worst-case scenario for a future reaction. The criticality of the allergy condition is not the same as the severity of the reaction. For example, a severe rash may have a low risk (or criticality) of a life-threatening reaction. -
encounter Encounter false The encounter associated with the allergy. -
id string true The unique ID of the allergy record. -
notes [ProviderNote] true The notes or comments associated with the allergy. -
onset string false The clinically significant date when the allergy was first reported as present. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
reactions [Reaction] true The clinical symptoms and their severity when the patient was exposed to the allergen substance, for example, a mild rash, moderate hives, or severe swelling. -
resolvedOn string false The date and time when the allergy was updated to a resolved status. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
sourceIdentifier SourceIdentifier false An ID that uniquely identifies this allergy for a patient in a data partition. -
status CodeableConcept false The current state of the allergy, for example, Active, Inactive, Canceled, or Resolved. -
type CodeableConcept false The type of allergic reaction, such as allergy or intolerance. -

Asserter

Name Type Required Description Accepted Values
provider Provider false The provider who asserted the allergy. -
providerRoles [CodeableConcept] true The role or roles of the provider who asserted the allergy. -
relatedPerson CodeableConcept false A person who has a relationship with the patient outside of a health care role who is the source of the information about the allergy being recorded. -
type string false The type, or role, of the individual who provided the assertion. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. -
name ProviderName false The attributes of the provider name. -

ProviderAlias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -
type string true The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
given [string] true A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. -
family [string] true A list of family (last) name portions of the person’s name. Some people have multiple family names. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
formatted string false The person’s fully-formatted name. -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] true A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] true The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Encounter

Name Type Required Description Accepted Values
id string false The unique ID of the encounter. -

ProviderNote

Name Type Required Description Accepted Values
date string false The date when the note was recorded. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string true The textual content of the note or comment. -
author Provider false The individual who recorded the note or comment. -
type CodeableConcept false The type of the note or comment. -

Reaction

Name Type Required Description Accepted Values
reaction CodeableConcept false The clinical symptoms when the patient was exposed to the allergen substance, for example, a rash, hives, or swelling. -
severity CodeableConcept false The degree of the reaction’s physiological effects, such as mild, moderate, or severe. The severity of the allergy condition is not the same as the criticality of the reaction. For example, a severe rash may have a low risk (or criticality) of a life-threatening reaction. -

SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string false The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
id string false An ID that uniquely identifies this entity for a patient in the data partition. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Allergies

Name Type Required Description Accepted Values
items [Allergy] true [Retrieves a single allergy for a given patient.] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -