AllergyIntolerance read

get/AllergyIntolerance/{id}

Page View

This resource contains recorded details about a patient’s allergy or intolerance to medication, food, materials, or other substances.

AllergyIntolerance provides a holistic view of a documented allergy so that you know whether the allergy is ongoing or how severely the patient reacts. A documented allergy may be active or resolved, and the patient’s reaction may be anywhere from moderate to severe.

You can review or retrieve allergy information.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

Review a specific AllergyIntolerance resource with details about a patient's active or resolved allergies.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/AllergyIntolerance/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
AllergyIntolerance identifier

Response fields and example

json

1
{}

A profile on the AllergyIntolerance resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: AllergyIntolerance
code
required, object
Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
patient
required, object
The patient who has the allergy or intolerance.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
clinicalStatus
string
The clinical status of the allergy or intolerance.
Possible Values: active, inactive, resolved
type
string
Identification of the underlying physiological mechanism for the reaction risk.
Possible Values: allergy, intolerance
_type
object
This element contains extensions for type. Depending on the extensions present it could be used in place of type or contain additional information about type. See the extension element for more details on the possible extensions being sent.
- extension
  Array of OriginalText or Other
  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
category
Array of string
Category of the identified substance.
Possible Values: food, medication, environment, biologic
criticality
string
Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
Possible Values: low, high, unable-to-assess
encounter
object
The encounter when the allergy or intolerance was asserted.

Must be a resource of type Encounter.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
asserter
object
The source of the information about the allergy that is recorded.

Must reference one of the following types of resources:
- RelatedPerson
- PractitionerRole
- Practitioner
- Patient
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
note
Array of object
Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
- text
  required, string
  The text of the annotation in markdown format.
reaction
Array of object
Details about each adverse reaction event linked to exposure to the identified substance.
- manifestation
  required, Array of object
  Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
- description
  string
  Text description about the reaction as a whole, including details of the manifestation if required.
- severity
  string
  Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
  Possible Values: mild, moderate, severe (of event as a whole)
- _severity
  object
  This element contains extensions for severity. Depending on the extensions present it could be used in place of severity or contain additional information about severity. See the extension element for more details on the possible extensions being sent.
  extension
  Array of OriginalText or Other
  May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  Any of:
  A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.
  
  See http://hl7.org/fhir/StructureDefinition/originalText for more information
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/originalText
  valueString
  required, string
  The original text
onsetDateTime
string
Estimated or actual date, date-time, or age when allergy or intolerance was identified.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.