Hard Delete DocumentReference
Hard Delete DocumentReference using FHIR R4 4.0.1.
Resource category: DocumentReference.
Endpoint
| Method | Endpoint |
|---|---|
POST | /api/fhir/r4/DocumentReference/{rid}/$hardDelete |
Use the R4 base URL from your DDFS instance. Send Authorization: Bearer <access-token> and accept application/fhir+json.
Parameters
| Parameter | Location | Required | Type | Description |
|---|---|---|---|---|
rid | Path | Yes | FHIR logical ID | The logical ID of the DocumentReference resource. |
Authorization
| Context | Resource scope |
|---|---|
| Resource-server definition / issued token | system/DocumentReference.d |
| Client grant / token request | ddfssystem/DocumentReference.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 one already soft-deleted DocumentReference resource and its history. A live resource must be soft-deleted first; attempting to hard-delete a live resource returns 409. Do not send a resource body.
- Permanent deletion: shared operation semantics.
- DocumentReference 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/DocumentReference/{rid}/$hardDelete
Responses
| Successful status | Meaning |
|---|---|
| 200 | An OperationOutcome describing the permanent-deletion 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/documentreference.html. Canonical profile URI: http://hl7.org/fhir/StructureDefinition/DocumentReference.
This is a DDFS custom operation. Definition: ddfs-r4-hardDelete.json.