Error handling

This page describes how errors are handled.

Errors

The CP-IS FHIR R4 API will return a UKCore-OperationOutcome when an API call is unsuccessful. The below table provides expected errors / validation failures.

e.g: 403 Error Operation Outcome


Search interaction

HTTP code issue-severity issue-type details.code / display details.diagnostics
400 error invalid INVALID_SEARCH_DATA Invalid NHS number
400 error invalid PRECONDITION_FAILED Missing or invalid head parameter
403 error forbidden ACCESS_DENIED Access has been denied to process this request