Purge Deleted AllergyIntolerance
Purge Deleted AllergyIntolerance using FHIR R4 4.0.1.
Resource category: AllergyIntolerance.
Endpoint
| Method | Endpoint |
|---|---|
POST | /api/fhir/r4/AllergyIntolerance/$purgeDeleted |
Use the R4 base URL from your DDFS instance. Send Authorization: Bearer <access-token> and accept application/fhir+json.
Send Content-Type: application/fhir+json.
Parameters
| Parameter | Location | Required | Type | Description |
|---|---|---|---|---|
before | FHIR Parameters body | Yes | dateTime | Required FHIR dateTime cutoff supplied as Parameters.parameter.valueDateTime; deleted resources before this instant are purged. |
limit | FHIR Parameters body | No | integer | Optional maximum supplied as Parameters.parameter.valueInteger. The route accepts values from 1 through 50. |
Authorization
| Context | Resource scope |
|---|---|
| Resource-server definition / issued token | system/AllergyIntolerance.d |
| Client grant / token request | ddfssystem/AllergyIntolerance.d |
| Additional custom scope | https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete |
Resource constraints still apply. Use the least privilege needed for this operation; see authentication and scope configuration.
Configure the Custom Hard-Delete Scope and follow the permanent-deletion policy.
Behavior
Permanently remove eligible soft-deleted AllergyIntolerance resources before the supplied cutoff. Supply before as valueDateTime and optional limit as valueInteger from 1 through 50 in a FHIR Parameters body.
- Purge deleted resources: shared operation semantics.
- AllergyIntolerance resource guidance: resource-specific requirements and restrictions.
- R4 CapabilityStatement and R4 metadata: supported capabilities.
Example Request
Replace the example logical IDs, version IDs and connection values with values for your workflow.
POST /api/fhir/r4/AllergyIntolerance/$purgeDeleted
Content-Type: application/fhir+json
{
"resourceType": "Parameters",
"parameter": [
{
"name": "before",
"valueDateTime": "2026-01-01T00:00:00Z"
},
{
"name": "limit",
"valueInteger": 10
}
]
}Responses
| Successful status | Meaning |
|---|---|
| 200 | An OperationOutcome describing the purge result. |
For common error statuses and FHIR-formatted error bodies, see OperationOutcome errors. Authentication/authorization responses follow the shared policy; a protected resource can be concealed as 404. See also interaction responses.
FHIR Definition
FHIR R4 definition: https://hl7.org/fhir/R4/allergyintolerance.html. Canonical profile URI: http://hl7.org/fhir/StructureDefinition/AllergyIntolerance.
This is a DDFS custom operation. Definition: ddfs-r4-purgeDeleted.json.