Ontario Subscription HL7® FHIR® Implementation Guide -v1.0.0-ballot1
For a full list of available versions, see the Directory of published versions
The Delete Subscription operation is used to logically delete a subscription from the Ontario Health subscription service. After deletion, the subscription resource will no longer be accessible by the client for further modifications or updates.
4.1.3.2.
This interaction involves a request by a Point of Service system to delete Subscription on the Subscription server. The request is received by the Subscription service which deletes the requested Subscription resource and returns an HTTP response code and an OperationOutcome resource if applicable.
Subscription Delete Request
The Delete Subscription will delete the specified FHIR Subscription resource from the repository.
DELETE [base]/Subscription/[id],
where [id] is the logical id of the existing Subscription resource.
Subscription Delete Response
The server returns a 200 OK HTTP status code.
HTTP Method:
DELETE
Headers:
Content-Type: application/fhir+json
Address:
[base]/Subscription/f63b8b72-23b4-4c3f-8a07-8fbe93d46f9d
| Case | Scenario Description | HTTP Status Code | Response Payload |
|---|---|---|---|
| 1 | An existing Subscription is deleted from the repository | HTTP 200 | Deleted. |
| 2 | Requestor do not have authorizization to delete the Subscription (i.e., the user lacks sufficient permissions) | HTTP 403 | Forbidden. |
| 3 | The subscription ID does not exist on the server, meaning it was already deleted or never existed | HTTP 404 | Not Found. |
| 4 | Subscription API validates the request but cannot return a valid response due to internal issues. | HTTP 500 | Internal Server Error. Returns an OperationOutcome resource indicating an issue. |