AllergyIntolerance
The AllergyIntolerance resource represents registered allergies and intolerances for a patient in Open Aidn.
Open Aidn currently exposes selected fields from the base HL7 FHIR R4 AllergyIntolerance resource. A formal Aidn profile may be published later.
Standards and profiles
- HL7 FHIR R4: AllergyIntolerance
- HL7 FHIR R4 search: FHIR search
Endpoints
| Method | Path | Required scope | Description |
|---|---|---|---|
POST |
/AllergyIntolerance/_search |
allergyintolerance.search |
Search using application/x-www-form-urlencoded body parameters. |
Search responses are returned as FHIR Bundle resources with type set to searchset.
Search parameters
| Parameter | Type | Description |
|---|---|---|
patient.Identifier |
identifier | Patient identifier used to filter allergies and intolerances for one patient. |
_include |
token, repeatable | Adds supported referenced resources to the response bundle. |
patient.Identifier is required for search.
Supported includes
_include value |
Included resource | Description |
|---|---|---|
AllergyIntolerance:recorder |
Practitioner |
Adds referenced recorder resources. |
AllergyIntolerance:patient |
Patient |
Adds referenced patient resources. |
Response fields
Open Aidn may expand the response over time, but integrations should currently expect data in these fields:
| Field | Description |
|---|---|
id |
AllergyIntolerance identifier. |
meta.lastUpdated |
Last update timestamp when available. |
code |
Allergy or intolerance coding. |
clinicalStatus |
Clinical status, such as active, inactive, resolved, or unknown. |
verificationStatus |
Verification status when available. |
patient.reference |
Reference to the patient. |
recorder.reference |
Reference to the practitioner who recorded the allergy when available. |
note |
Free-text note when available. |
onset[x] |
Onset date or age when available. |
reaction |
Reaction manifestation, severity, and description when available. |
category |
FHIR allergy category when available. |
criticality |
Criticality when available. |
Example search
POST /AllergyIntolerance/_search HTTP/1.1
Host: <OPEN_AIDN_FHIR_HOST>
Accept: application/fhir+json
Content-Type: application/x-www-form-urlencoded
Authorization: Bearer <ACCESS_TOKEN>
patient.Identifier=<PATIENT_IDENTIFIER>&_include=AllergyIntolerance:patientThe response is a FHIR search bundle with matching AllergyIntolerance resources and any requested includes.