AllergyIntolerance

Work with FHIR R4 4.0.1 AllergyIntolerance resources.

Choose an operation for this resource:

The diagram summarizes AllergyIntolerance requests and responses. See Supported FHIR REST Interactions for the shared interaction model.

FHIR R4 definition: https://hl7.org/fhir/R4/allergyintolerance.html. See interaction response codes and common error responses.

Use /api/fhir/r4/AllergyIntolerance for FHIR R4 4.0.1 allergy and intolerance records. FHIR R6 AllergyIntolerance is not supported.

Interactions

Resource lifecycle: create, read, versioned read, update, soft deletion and version preconditions.
PUT-as-create and restoration: creation/restoration, server-managed metadata, response headers and return preferences.
Interaction responses: success status codes.
OperationOutcome errors: common errors and response bodies.
Batch requests: independent entry processing.

AllergyIntolerance capability	Support or requirement
Conditional create	Not supported.
Conditional update	Not supported.
Transaction bundles	Not supported.

Create example

{
  "resourceType": "AllergyIntolerance",
  "clinicalStatus": {"coding": [{"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active"}]},
  "verificationStatus": {"coding": [{"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed"}]},
  "category": ["medication"],
  "code": {"coding": [{"system": "http://snomed.info/sct", "code": "91936005"}]},
  "patient": {"reference": "Patient/patient-438"}
}

Search

Search operation: endpoints, complete parameter table, supported forms and examples.
Common Search Controls: shared controls and server-provided paging links.
Value Types and Syntax and Comparators, Modifiers, and Chains: shared syntax. Use only the forms supported by this resource.

AllergyIntolerance detail	Requirement or behavior
Limitations	Repeated `date` bounds are supported; repeated resource-specific tokens and comma alternatives are unsupported.
Write provenance	Use established DDFS paging, sorting, total, and Provenance reverse-include controls as advertised by live metadata.
Limitations	Encounter/context filters, clinician filters, detailed reaction searches, new chains, reverse chains, composites, and full-text search are not supported.

Parameter	Meaning
`identifier`	Top-level identifiers, using value, `system\|value`, `\|value`, or system\|. One unmodified token is supported.
`patient`	The Patient reference; the existing `:identifier` modifier is supported.
clinical-status	Coded `clinicalStatus`, such as `active`, `inactive`, or resolved.
verification-status	Coded `verificationStatus`, such as confirmed or entered-in-error. It is independent of clinical-status.
`code`	Codings in either `code` or reaction.substance.
`category`	food, `medication`, environment, or biologic.

GET /api/fhir/r4/AllergyIntolerance?patient=Patient/patient-438&code=91936005&category=medication&clinical-status=active&verification-status=confirmed&_lastUpdated=ge2026-01-01&_lastUpdated=lt2027-01-01

Validation and permissions

For shared validation-error responses, see OperationOutcome errors.

Authentication and Scopes: bearer tokens, scope configuration and constrained access. Required resource scopes are listed on each operation page.
Data Deletion and Purge Operations: permanent-deletion eligibility and additional permissions.
Hard Delete and Purge Deleted: resource endpoints and required scopes; see also shared purge guidance.

AllergyIntolerance detail	Requirement or behavior
Required content	Supply a Patient reference and valid R4 content.
`clinicalStatus`	`clinicalStatus` must be present unless `verificationStatus` is `entered-in-error`, in which case `clinicalStatus` must be absent.
Choice elements	Required `status` bindings and the single `onset` choice apply.
`reaction`	Each reaction requires at least one manifestation.

Limitations

AllergyIntolerance detail	Requirement or behavior
Limitations	Conditional create, conditional update, and transactions are not supported.
Resource rule	This resource does not establish US Core certification.