Operation $bulk-purge on Patient
$bulk-purge operation is used to delete all resources, as well as their history, related to a given array of Patients (as per patient compartment definition). Current operation call $purge for each Patient in Parameters.
This operation is asynchronous and follows the async request pattern.
$bulk-purge operation uses hard delete and can't be rolled back.
This operation requires the following SMART on FHIR scopes:
- system/kodjin/$patient-purge
- user/kodjin/$patient-purge
- patient/kodjin/$patient-purge
You can read more about smart-on-FHIR scopes on SMART on FHIR Authorization page
Endpoints:
- POST [fhir_base]/fhir/Patient/$bulk-purge
Purpose
Kickoff the patient purge request.
Request
Headers
| Name | Value | Required | Documentation |
|---|---|---|---|
| Prefer | respond-async | true | Specifies that the response is asynchronous. Synchronous interaction isn't supported for this operation |
Request parameters (in body)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| patientId | 1…1 | string | The id of the patient |
Response
Headers
| Name | Required | Documentation |
|---|---|---|
| Content-Location | true | The absolute URL of an endpoint for subsequent status requests (polling location) |
Response parameters (in body)
None
Examples
Example - Patient $bulk-purge kickoff
POST https://demo.kodjin.com/fhir/Patient/$bulk-purge # The HTTP Method and Path
Prefer: respond-async # Headers
{
"resourceType": "Parameters",
"parameter": [
{
"name": "patientId",
"valueString": "4a426db7-4fc4-4b19-8715-22a75cb67e03"
},
{
"name": "patientId",
"valueString": "5aece5b6-3f64-4efd-9124-5236c8079559"
},
{
"name": "patientId",
"valueString": "8a1915e6-32a6-4a33-9a10-78921cbf0f2e"
}
]
}
- GET [fhir_base]/fhir/Patient-bulk-purge/[bulk-job-id]
Purpose
Get the status of the purge operation.
Request
Headers
None
Path parameters
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| bulk-job-id | 1…1 | string | The id of the purge job |
Request parameters (in body)
None
Response
Headers
None
Response parameters (in body, as Parameters resource)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| result | 1…* | Result for one Patient id | |
| result.patientId | 1…1 | String | The id of the patient for which the purge is performed |
| result.updatedAt | 1…1 | DateTime | The updated at time for this job |
| result.status | 1…1 | Code | The status of this job. One of: new, processing, completed, error |
| result.totalResourcesCount | 0…1 | Integer | The total number of patient's resources to be purged |
| result.purgedResourcesCount | 0…1 | Integer | The number of purged patient's resources as to the updatedAt time |
Example - Patient $purge get the job status
Status: 200 OK # The HTTP status
{ # The body
"resourceType": "Parameters",
"parameter": [
{
"name": "result",
"part": [
{
"name": "patientId",
"valueId": "3cf2f3f2-827f-4ce5-9c10-290159350958"
},
{
"name": "updatedAt",
"valueDateTime": "2024-07-03T14: 46: 45.107453265Z"
},
{
"name": "status",
"valueCode": "new"
},
]
},
{
"name": "result",
"part": [
{
"name": "patientId",
"valueId": "e3eaf2de-044f-40a6-b253-d5dd3a314b47"
},
{
"name": "updatedAt",
"valueDateTime": "2024-07-03T14: 46: 45.107453265Z"
},
{
"name": "status",
"valueCode": "new"
},
]
},
]
}
Status: 200 OK # The HTTP status
{ # The Body
"resourceType": "Parameters",
"parameter": [
{
"name": "result",
"part": [
{
"name": "patientId",
"valueId": "3cf2f3f2-827f-4ce5-9c10-290159350958"
},
{
"name": "updatedAt",
"valueDateTime": "2024-07-03T14: 46: 45.107453265Z"
},
{
"name": "status",
"valueCode": "processing"
},
{
"name": "totalResourcesCount",
"valueInteger": 500
},
{
"name": "purgedResourcesCount",
"valueInteger": 250
},
]
},
{
"name": "result",
"part": [
{
"name": "patientId",
"valueId": "e3eaf2de-044f-40a6-b253-d5dd3a314b47"
},
{
"name": "updatedAt",
"valueDateTime": "2024-07-03T14: 46: 45.107453265Z"
},
{
"name": "status",
"valueCode": "completed"
},
{
"name": "totalResourcesCount",
"valueInteger": 400
},
{
"name": "purgedResourcesCount",
"valueInteger": 400
},
]
},
]
}