Interaction: Delete Subscription

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.

Specification

This specification is based on the FHIR R5 Backport Delete operations.

Usage

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.

Interaction Sequence Diagram

Sub_Delete

Example Delete Subscription Interaction

HTTP Method:

DELETE

Headers:

Content-Type: application/fhir+json

Address:

[base]/Subscription/1455

Expected Behaviour

Case Scenario Description HTTP Status Code Response Payload
1 An existing Subscription is deleted from the repository HTTP 200 Deleted.
2 The subscription ID does not exist on the server, meaning it was already deleted or never existed HTTP 404 Not Found.
3 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.