The FHIR R4 AllergyIntolerance resource captures a patient's allergies or intolerances to substances like medications, foods, or environmental agents. It helps healthcare providers manage adverse reactions and supports safe clinical decisions.
Use Cases
- Retrieve allergy records before prescribing medications
- Log new allergies during a patient intake
- Monitor allergy status updates using webhooks
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/AllergyIntolerance
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/AllergyIntolerance
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required Scopes
allergyintolerance.readfor GETallergyintolerance.writefor POST, PUT, DELETE
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Read AllergyIntolerance | Retrieves a specific AllergyIntolerance record by its FHIR ID. |
GET | Search AllergyIntolerance | Searches for AllergyIntolerance records for a specified patient. |
POST | Create AllergyIntolerance | Submits a new AllergyIntolerance record to the Health Gorilla FHIR server. |
PUT | Update AllergyIntolerance | Updates an existing AllergyIntolerance record by full resource replacement. |
DELETE | Delete AllergyIntolerance | Removes an existing AllergyIntolerance record from the system by full deletion. |
Frequently Used Search Parameters
| Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Filters by patient ID | Patient/{id} | Reference | Yes |
clinicalStatus | Filters by the current status of the allergy | AllergyIntoleranceClinicalStatus (active) | token | No |
verificationStatus | Filters by level of certainty | AllergyIntoleranceVerificationStatus (confirmed) | token | No |
recordedDate | Filters by the date the allergy was recorded | ge2022-01-01, le2023-12-31 | date | No |
category | Filters by the allergen category | AllergyIntoleranceCategory (food) | token | No |
code | Filters by the substance causing the allergy | SNOMED CT or RxNorm codes (e.g., 227493005) | token | No |
recorder | Filters by the practitioner or person who recorded the allergy | Practitioner/{id}, RelatedPerson/{id} | Reference | No |
criticality | Filters by the potential severity of the reaction | AllergyIntoleranceCriticality (high) | token | No |
onset | Filters by the onset date of the allergy or intolerance | ge2020-01-01 | date | No |
lastOccurrence | Filters by the date of the most recent allergic reaction | le2024-12-31 | date | No |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
patient | Reference to the patient who has the allergy or intolerance | Patient/{id} | Reference(Patient) | Yes |
code | Substance or allergen | SNOMED CT or RxNorm codes (e.g., aspirin, peanuts) | CodeableConcept | Yes |
type | Type of adverse sensitivity | allergy, intolerance | code | No |
category | Category of the substance | food, medication | code[] | No |
criticality | Potential severity of the reaction if exposed | high | code | No |
clinicalStatus | The current status of the allergy | active | CodeableConcept | No |
verificationStatus | Certainty about the presence of the allergy | confirmed | CodeableConcept | No |
onset | Estimated or known date/time when the allergy began | YYYY-MM-DD, age, period | dateTime, Age, etc. | No |
recordedDate | When the allergy was first recorded | YYYY-MM-DD | dateTime | No |
lastOccurrence | Most recent known occurrence of a reaction | YYYY-MM-DD | dateTime | No |
recorder | Who recorded the allergy (user or system) | Practitioner/{id}, RelatedPerson/{id} | Reference | No |
reaction.manifestation | Symptoms/signs that manifested during the reaction | SNOMED CT codes (hives, dyspnea, etc.) | CodeableConcept[] | No |
reaction.severity | Severity of the reaction | mild, moderate, severe | code | No |
reaction.substance | Specific substance causing the reaction (if different from code) | e.g., penicillin G | CodeableConcept | No |
reaction.description | Text description of the reaction | Free-text | string | No |
Webhooks
Clients can subscribe to receive notifications when new allergies or intolerances are recorded, or when existing records are updated or resolved. For more information, go to: Webhooks & Polling.
Error Handling
All AllergyIntolerance operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses. For more information, go to: Error Handling.