Delete Patient by ID
DELETE {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}
Description:
This API endpoint allows you to delete a specific patient record within the context of the specified tenant and instance. It provides a way to remove patient data from the system permanently.
Parameters:
url
: The base URL of the API.tenantName
: The name or identifier of the tenant within which the patient record exists.instanceName
: The name or identifier of the specific instance under the given tenant.patientId
: The unique identifier of the patient record you want to delete.
Request Headers:
No special headers are required for this request.
Request Body:
This endpoint does not require a request body.
Response:
- 204 No Content: The request was successful, and the patient record has been deleted. No response body will be returned.
- 404 Not Found: The requested patient or resource was not found. An error message or response body may provide additional information.
Authorization:
Ensure that the caller of this endpoint has the necessary permissions to delete patient records. Implement appropriate authentication and authorization mechanisms.
Usage:
Before using this endpoint, ensure that you have the correct URL, tenant name, instance name, and patient ID. Make sure to handle responses, especially errors, appropriately in your application.
Notes:
- Deleting a patient record is irreversible, so exercise caution while using this endpoint.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
type | string | ID,EGUID |