Get HealthcareService
The Get Subscription operation is used to retrieve a subscription from the Ontario Health publication service.
Specification
This specification is based on the FHIR R4B Delete operations.
Subscription Get Request
The Get Subscription will retrieve the specified FHIR Subscription resource from the repository.
Usage:
GET [base]/Subscription/[id]
, where [id] is the logical id of the existing Subscription resource.
Subscription GET Response
The server returns a 200 OK HTTP status code.
The server returns a 200 OK HTTP status code, and also returns a copy the Subscription resourse in the HTTP body.
Example GET Request
HTTP Method:
GET
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 retrievd from the repository | HTTP 200 | Retrieved |
2 | The requested Subscription based on the provided logical id does not exist | HTTP 404 | Resource not found. Returns an OperationOutcome resource indicating an issue. |
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. |