Error States (Transactional)

Overview

Medicus uses conventional HTTP response codes to indicate the success or failure of an API request. Error states are restricted to the individual endpoint. An error state from a parallel or previous action will not be returned.

Errors are always returned with a HTTP response code and a JSON body that describes the errors:

This includes:

HTTP response code
The errors array:
- code (string) the Medicus error code
- title (string) the error's title
- detail (string) more detail about the error

Generic Error Response Codes

The following error states occur outside of the endpoint-specific error states.

HTTP Code	Error Code	Scenario
`401`	`UNAUTHORISED`	'Unauthorised access. This app has not been accredited for this endpoint.
`401`	`NO_JWT_TOKEN_SUPPLIED`	No JWT token was supplied
`401`	`INVALID_CREDENTIALS`	The provided authentication credentials are invalid.
`401`	`LINKAGE_DOESNT_EXIST`	A Patient App Linkage doesn't exist between this app and the patient (PFS only).
`404`	`PATIENT_NOT_FOUND`	No patient record exists with the specified Patient ID.
`500`	`INTERNAL_SERVER_ERROR`	An internal server error has occurred on the Medicus platform. This may be as a result of a service outage or another issue. If the problem persists, please contact the Medicus Health API team.

Example Response (Patient Not Found)

JSON

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "errors": [
    {
      "code": "PATIENT_NOT_FOUND"
      "title": "Patient Not Found",
      "detail": "No patient record exists with the specified Patient ID."
    }
  ]
}

Example Response (Internal Server Error)

JSON

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR"
      "title": "Internal server error",
      "detail": "An issue has ooccurred on the Medicus provider API"
    }
  ]
}