Home
API reference
FHIR® API
FHIR® resources
AllergyIntolerance
_search

AllergyIntolerance _search

post/AllergyIntolerance/_search
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.

_search

Query for a patient's allergy details from one organization.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/AllergyIntolerance/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'clinical-status=string' \
6
--data-urlencode 'patient=string' \
7
--data-urlencode 'patient.identifier=string'

Request Body Schema

  • clinical-status
    Array of string

    active | inactive | resolved

  • patient
    Array of string

    Who the sensitivity is for

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "AllergyIntolerance",
9
        "id": "AllergyExample",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
13
            "value": "35892347"
14
          }
15
        ],
16
        "clinicalStatus": {
17
          "coding": [
18
            {
19
              "code": "active",
20
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
21
              "display": "Active"
22
            }
23
          ],
24
          "text": "Active"
25
        },
26
        "type": "allergy",
27
        "_type": {
28
          "extension": [
29
            {
30
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
31
              "valueString": "Propensity to adverse reaction to drug"
32
            }
33
          ]
34
        },
35
        "criticality": "low",
36
        "code": {
37
          "coding": [
38
            {
39
              "code": "2670",
40
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
41
              "display": "Codeine"
42
            }
43
          ],
44
          "text": "Codeine"
45
        },
46
        "patient": {
47
          "reference": "Patient/RedoxPatientExampleTimothy"
48
        },
49
        "encounter": {
50
          "reference": "Encounter/RedoxEncompassingEncounterExample"
51
        },
52
        "onsetDateTime": "2022-01-03T16:30:00.000Z",
53
        "reaction": [
54
          {
55
            "manifestation": [
56
              {
57
                "coding": [
58
                  {
59
                    "code": "267036007",
60
                    "system": "http://snomed.info/sct",
61
                    "display": "Shortness of Breath"
62
                  }
63
                ]
64
              }
65
            ],
66
            "description": "Shortness of Breath",
67
            "severity": "moderate",
68
            "_severity": {
69
              "extension": [
70
                {
71
                  "url": "http://hl7.org/fhir/StructureDefinition/originalText",
72
                  "valueString": "Mild to moderate"
73
                }
74
              ]
75
            }
76
          }
77
        ],
78
        "note": [
79
          {
80
            "text": "Additional information"
81
          }
82
        ]
83
      },
84
      "search": {
85
        "mode": "match"
86
      }
87
    }
88
  ]
89
}

    Response to a AllergyIntolerance search operation

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a response to a search

    Value: searchset
  • total
    required, number

    The total number of matches

  • entry
    Array of AllergyIntolerance or Other

    A resource matching the search criteria or related to a matching resource

    • resource
      required, object

      A matching AllergyIntolerance resource that corresponds to the search parameters

      • 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.

            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.

              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.

    • search
      required, object

      Information about the search process that lead to the creation of this entry.

      • mode
        required, string

        Identifies the AllergyIntolerance as matching the search parameters

        Value: match