Purge Deleted Specimen
Purge deleted FHIR R4 Specimen resources by cutoff date and limit.
Endpoint
POST /api/fhir/r4/Specimen/$purgeDeleted
Base URL: https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4
Parameters
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
before |
body | true | dateTime | Required FHIR dateTime cutoff supplied as Parameters.parameter.valueDateTime; deleted resources before this instant are purged. Supply this input as Parameters.parameter.valueDateTime. |
limit |
body | false | integer | Optional maximum supplied as Parameters.parameter.valueInteger. The route accepts values from 1 through 50. Supply this input as Parameters.parameter.valueInteger. |
Authorization
The supported authorization model uses OAuth 2.0 scopes issued by OCI Identity Domains. Send the access token as a bearer token. Resource-server definitions and issued access-token claims use canonical system/... scopes. Client grants and token requests use the corresponding ddfssystem/... form. For examples, see Reference: Authentication and Scopes.
| Context | Scope form |
|---|---|
| Resource-server definition | system/Specimen.d, https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete |
| Client grant/token request | ddfssystem/Specimen.d, ddfshttps://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete |
Issued token's scope claim |
system/Specimen.d, https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete |
Hard-delete and purge-deleted operations require both matching resource delete authority and the canonical DDFS hard-delete scope.
Behavior
Purges deleted Specimen resources matching the operation parameters. Requires delete authority and the hard-delete scope.
Response
The required return output has cardinality 1..1 and type OperationOutcome.
FHIR Definition
Canonical: https://hl7.org/fhir/R4/specimen.html
Operation definition: https://docs.oracle.com/iaas/device-data-fhir/OperationDefinition/ddfs-r4-purgeDeleted.json
Published JSON Definitions
Operation Definition JSON