1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. AllergyIntolerance

Get a list of allergy intolerances

get

/AllergyIntolerance

Retrieves a list of allergy intolerances that meet supplied query parameters.

Authorization Types

This operation supports the following authorization types:

Request

Query Parameters
  • The logical resource ID.
    • This parameter is required if the patient parameter is not used.
    • May not be provided with any other parameters except for _revinclude as indicated below.
    Example: _id=12345
  • The date range in which the allergy record was last updated.
    • This parameter may be provided up to two times, and must use the eq, ge, gt, le, or lt prefixes.
    • When a value is provided without a prefix, an implied eq prefix is used.
    • When provided twice, the lower value must have a ge or gt prefix and the higher value must have an le or lt prefix.
    Example: _lastUpdated=gt2014-09-24T12:00:00.000Z
  • The provenance resource entries to be returned as part of the bundle.
    • May be provided once with the Provenance:target value. Example: _revinclude=Provenance:target
    • May be provided with the _id parameter. Example: _id=178866310&_revinclude=Provenance:target
    • May be provided with the _patient parameter. Example: _patient=12742399&_revinclude=Provenance:target
    • When _revinclude is provided in a request to the closed endpoint, the OAuth2 token must include the scope corresponding with the authorization type, such as user/Provenance.read, patient/Provenance.read, or system/Provenance.read.
    Example: _revinclude=Provenance:target
  • The clinical status of the allergy or intolerance.
    Example: active, inactive, resolved
  • Who the sensitivity is for. This parameter is required if the _id parameter is not used.
    Example: patient=12345
Header Parameters
Back to Top

Response

Supported Media Types

Default Response

Example search by patient.
Example Request: 
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?patient=12742399
Example Response: 
{
    'resourceType': 'Bundle',
    'id': '30e959ca-24f5-43a5-bf8d-46bbb1991b01',
    'type': 'searchset',
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?patient=12742399'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/12760025',
        'resource': R4_ALLERGY_INTOLERANCE_ENTRY
      },
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/12760007',
        'resource': {
          'resourceType': 'AllergyIntolerance',
          'id': '12760007',
          'meta': {
            'versionId': '12760007',
            'lastUpdated': '2020-03-04T20:13:51Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Allergy Intolerance</b></p><p><b>Patient</b>: SMART, SANDY A</p><p><b>Allergy</b>: Cow&#39;s milk (substance)</p><p><b>Verification Status</b>: Confirmed</p><p><b>Clinical Status</b>: Active</p><p><b>Criticality</b>: High Risk</p><p><b>Category</b>: Food</p><p><b>Reactions</b>: Hives</p><p><b>Onset</b>: Dec 14, 2019  6:00 P.M. CST</p></div>'
          },
          'contained': [
            {
              'resourceType': 'RelatedPerson',
              'id': '638993',
              'patient': {
                'reference': 'Patient/12742399',
                'display': 'SMART, SANDY A'
              },
              'relationship': [
                {
                  'coding': [
                    {
                      'system': 'http://snomed.info/sct',
                      'code': '35359004',
                      'display': 'Family (social concept)'
                    },
                    {
                      'system': 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
                      'code': 'FAMMEMB',
                      'display': 'family member'
                    }
                  ],
                  'text': 'family member'
                }
              ]
            }
          ],
          'clinicalStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical',
                'code': 'active',
                'display': 'Active'
              }
            ],
            'text': 'Active'
          },
          'verificationStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification',
                'code': 'confirmed',
                'display': 'Confirmed'
              }
            ],
            'text': 'Active'
          },
          'type': 'allergy',
          'category': [
            'food'
          ],
          'criticality': 'high',
          'code': {
            'coding': [
              {
                'system': 'http://snomed.info/sct',
                'code': '3718001',
                'display': "Cow's milk (substance)"
              }
            ],
            'text': "Cow's Milk"
          },
          'patient': {
            'reference': 'Patient/12742399',
            'display': 'SMART, SANDY A'
          },
          'encounter': {
            'reference': 'Encounter/97953523'
          },
          'onsetDateTime': '2019-12-15T00:00:00Z',
          'recordedDate': '2020-03-04T20:13:51Z',
          'recorder': {
            'reference': 'Practitioner/12724045',
            'display': 'Graham, Joshua'
          },
          'asserter': {
            'reference': '#638993'
          },
          'reaction': [
            {
              'id': '12760009',
              'manifestation': [
                {
                  'coding': [
                    {
                      'system': 'http://snomed.info/sct',
                      'code': '247472004',
                      'display': 'Weal (disorder)'
                    }
                  ],
                  'text': 'Hives'
                }
              ]
            }
          ]
        }
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-with-nil-clinicalStatus Response

Example search of allergy intolerance records where clinicalStatus is missing.
Example Request: 
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?patient=19785380
Example Response: 
{
    'resourceType': 'Bundle',
    'id': '8d48e45a-d247-4f93-8d38-b5302a64e7ba',
    'type': 'searchset',
    'link': [
      {
        'relation': 'self',
        'url': 'http://localhost:3000/r4/91fd1841-fb25-42f3-a48e-1264a2c6b72a/AllergyIntolerance?patient=19785380'
      }
    ],
    'entry': [
      {
        'fullUrl': 'http://localhost:3000/r4/91fd1841-fb25-42f3-a48e-1264a2c6b72a/AllergyIntolerance/14891127',
        'resource': {
          'resourceType': 'AllergyIntolerance',
          'id': '14891127',
          'meta': {
            'versionId': '14892293',
            'lastUpdated': '2024-04-23T09:56:39Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns=\???http://www.w3.org/1999/xhtml\???><p><b>Allergy Intolerance</b></p><p><b>Patient</b>: NEW, BORN</p><p><b>Allergy</b>: Aspirin</p><p><b>Verification Status</b>: Unconfirmed</p><p><b>Clinical Status</b>: Active</p><p><b>Category</b>: Medication</p></div>'
          },
          'clinicalStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical',
                'code': 'active',
                'display': 'Active'
              }
            ],
            'text': 'Proposed'
          },
          'verificationStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification',
                'code': 'unconfirmed',
                'display': 'Unconfirmed'
              }
            ],
            'text': 'Proposed'
          },
          'type': 'allergy',
          'category': [
            'medication'
          ],
          'code': {
            'coding': [
              {
                'system': 'http://www.nlm.nih.gov/research/umls/rxnorm',
                'code': '1191',
                'display': 'Aspirin'
              }
            ],
            'text': 'aspirin'
          },
          'patient': {
            'reference': 'Patient/19785380',
            'display': 'NEW, BORN'
          },
          'encounter': {
            'reference': 'Encounter/101540658'
          },
          'recordedDate': '2024-04-17T13:26:49Z',
          'recorder': {
            'reference': 'Practitioner/13990091',
            'display': 'PCCAC, UserOne'
          }
        },
        'search': {
          'mode': 'match'
        }
      },
      {
        'fullUrl': 'urn:uuid:2f511c7d-bc0e-42a5-af2d-97de95f7ea3a',
        'resource': {
          'resourceType': 'OperationOutcome',
          'issue': [
            {
              'severity': 'warning',
              'code': 'suppressed',
              'diagnostics': 'Other search results were found but could not be compliantly expressed and hence have been suppressed'
            }
          ]
        },
        'search': {
          'mode': 'outcome'
        }
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-with-patient-auth Response

Example search using patient authorization.
Example Request: 
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?patient=12742399
Example Response: 
{
    "resourceType": 'Bundle',
    "id": '92a4b8d7-58dc-4b37-b387-bebeb68def51',
    "type": 'searchset',
    "link": [
      {
        "relation": 'self',
        "url": 'http://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?patient=12724066'
      }
    ],
    "entry": [
      {
        'fullUrl': 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/12766993',
        'resource': R4_ALLERGY_INTOLERANCE_PATIENT_ENTRY
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-with-revinclude Response

Example search while using the _revinclude parameter.
Example Request: 
GET https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?_id=74771957,S-75479691&_revinclude=Provenance:target
Example Response: 
{
    'resourceType': 'Bundle',
    'id': '65ee4c79-3514-4eab-b606-10ad56fb0d5d',
    'type': 'searchset',
    'link': [
      {
        'relation': 'self',
        'url': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance?_id=74771957%2CS-75479691&_revinclude=Provenance%3Atarget'
      }
    ],
    'entry': [
      {
        'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/74771957',
        'resource': {
          'resourceType': 'AllergyIntolerance',
          'id': '74771957',
          'meta': {
            'versionId': '74771957',
            'lastUpdated': '2019-05-15T13:15:25Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\'><p><b>Allergy Intolerance</b></p><p><b>Patient</b>: John, Smith</p><p><b>Allergy</b>: Peanut - dietary (substance)</p><p><b>Verification Status</b>: Confirmed</p><p><b>Clinical Status</b>: Active</p><p><b>Criticality</b>: High Risk</p><p><b>Category</b>: Medication</p><p><b>Onset</b>: May 15, 2019  1:15 P.M. UTC</p></div>'
          },
          'clinicalStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical',
                'code': 'active',
                'display': 'Active'
              }
            ],
            'text': 'Active'
          },
          'verificationStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification',
                'code': 'confirmed',
                'display': 'Confirmed'
              }
            ],
            'text': 'Active'
          },
          'type': 'allergy',
          'category': [
            'medication'
          ],
          'criticality': 'high',
          'code': {
            'coding': [
              {
                'system': 'http://snomed.info/sct',
                'code': '256349002',
                'display': 'Peanut - dietary (substance)'
              }
            ],
            'text': 'Peanuts'
          },
          'patient': {
            'reference': 'Patient/150915497',
            'display': 'John, Smith'
          },
          'encounter': {
            'reference': 'Encounter/44324934'
          },
          'onsetDateTime': '2019-05-15T13:15:25Z',
          'recordedDate': '2019-05-15T13:15:25Z',
          'recorder': {
            'reference': 'Practitioner/8176589',
            'display': 'DIRECTORYSERVICEUSER, DIRECTORYSERVICEUSER'
          },
          'asserter': {
            'reference': 'Patient/150915497',
            'display': 'John, Smith'
          }
        },
        'search': {
          'mode': 'match'
        }
      },
      {
        'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/AllergyIntolerance/S-75479691',
        'resource': {
          'resourceType': 'AllergyIntolerance',
          'id': 'S-75479691',
          'meta': {
            'versionId': '1',
            'lastUpdated': '2020-03-19T20:47:44Z',
            'security': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/v3-ObservationValue',
                'code': 'UNCERTREL',
                'display': 'Uncertain Reliability'
              }
            ]
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\'><p><b>Allergy Intolerance</b></p><p><b>Patient</b>: MARSTON, JACK</p><p><b>Meta Security</b>: Uncertain Reliability</p><p><b>Allergy</b>: Strawberry (substance)</p><p><b>Verification Status</b>: Confirmed</p><p><b>Clinical Status</b>: Active</p><p><b>Criticality</b>: High Risk</p><p><b>Category</b>: Medication</p><p><b>Onset</b>: Sep 11, 2019 12:00 A.M. CDT</p><p><b>Note</b>: Allergy reported by patient.</p></div>'
          },
          'contained': [
            {
              'resourceType': 'PractitionerRole',
              'id': '638995',
              'code': [
                {
                  'coding': [
                    {
                      'system': 'http://snomed.info/sct',
                      'code': '106292003',
                      'display': 'Professional nurse (occupation)'
                    }
                  ],
                  'text': 'Professional nurse (occupation)'
                }
              ]
            }
          ],
          'clinicalStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical',
                'code': 'active',
                'display': 'Active'
              }
            ],
            'text': 'Active'
          },
          'verificationStatus': {
            'coding': [
              {
                'system': 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification',
                'code': 'confirmed',
                'display': 'Confirmed'
              }
            ],
            'text': 'Active'
          },
          'type': 'allergy',
          'category': [
            'medication'
          ],
          'criticality': 'high',
          'code': {
            'coding': [
              {
                'system': 'http://snomed.info/sct',
                'code': '102261002',
                'display': 'Strawberry (substance)'
              }
            ],
            'text': 'Strawberry'
          },
          'patient': {
            'reference': 'Patient/166045489',
            'display': 'MARSTON, JACK'
          },
          'onsetDateTime': '2019-09-11T05:00:00Z',
          'recorder': {
            'reference': 'Practitioner/1',
            'display': 'SYSTEM, SYSTEM'
          },
          'asserter': {
            'reference': '#638995'
          },
          'note': [
            {
              'authorReference': {
                'reference': 'Practitioner/2578010'
              },
              'text': 'Allergy reported by patient.'
            }
          ]
        },
        'search': {
          'mode': 'match'
        }
      },
      {
        'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/all-4957069',
        'resource': {
          'resourceType': 'Provenance',
          'id': 'all-4957069',
          'meta': {
            'versionId': '4957069',
            'lastUpdated': '2020-03-16T21:45:09Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\'><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>AllergyIntolerance/74771957</li></ul><p><b>Recorded</b>: Mar 16, 2020  4:45 P.M. CDT</p><p><b>Agents</b>:</p><dl><dt>Unknown</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-200</p></div>'
          },
          'target': [
            {
              'reference': 'AllergyIntolerance/74771957'
            }
          ],
          'recorded': '2020-03-16T21:45:09Z',
          'agent': [
            {
              'type': {
                'coding': [
                  {
                    'system': 'http://terminology.hl7.org/CodeSystem/provenance-participant-type',
                    'code': 'author'
                  }
                ],
                'text': 'Author'
              },
              'role': [
                {
                  'coding': [
                    {
                      'system': 'http://terminology.hl7.org/CodeSystem/contractsignertypecodes',
                      'code': 'SOURCE'
                    }
                  ],
                  'text': 'Source'
                }
              ],
              'who': {
                'reference': 'Organization/40475456',
                'display': 'Unknown'
              }
            }
          ],
          'entity': [
            {
              'role': 'source',
              'what': {
                'reference': 'DocumentReference/S-200'
              }
            }
          ]
        },
        'search': {
          'mode': 'include'
        }
      },
      {
        'fullUrl': 'https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance/all-16897171',
        'resource': {
          'resourceType': 'Provenance',
          'id': 'all-16897171',
          'meta': {
            'versionId': '16897171',
            'lastUpdated': '2021-03-26T08:03:53Z'
          },
          'text': {
            'status': 'generated',
            'div': '<div xmlns=\'http://www.w3.org/1999/xhtml\'><p><b>Provenance</b></p><p><b>Target</b>:</p><ul><li>AllergyIntolerance/S-75479691</li></ul><p><b>Recorded</b>: Mar 25, 2021  9:57 A.M. CDT</p><p><b>Agents</b>:</p><dl><dt>Baseline East Medical Center</dt><dd><b>Agent Type</b>: Author</dd><dd><b>Agent Role</b>: Source</dd></dl><p><b>Entity Source</b>: DocumentReference/S-201</p></div>'
          },
          'target': [
            {
              'reference': 'AllergyIntolerance/S-75479691'
            }
          ],
          'recorded': '2021-03-25T14:57:43Z',
          'agent': [
            {
              'type':
                {
                  'coding': [
                    {
                      'system': 'http://terminology.hl7.org/CodeSystem/provenance-participant-type',
                      'code': 'author'
                    }
                  ],
                  'text': 'Author'
                },
              'role': [
                {
                  'coding': [
                    {
                      'system': 'http://terminology.hl7.org/CodeSystem/contractsignertypecodes',
                      'code': 'SOURCE'
                    }
                  ],
                  'text': 'Source'
                }
              ],
              'who': {
                'reference': 'Organization/619848',
                'display': 'Baseline East Medical Center'
              }
            }
          ],
          'entity': [
            {
              'role': 'source',
              'what': {
                'reference': 'DocumentReference/S-201'
              }
            }
          ]
        },
        'search': {
          'mode': 'include'
        }
      }
    ]
  }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top