Error Handling
FHIR uses a RESTful interface and implements the following protocol for error handling:
Pre-processing / Communication Level Errors
Errors may occur during the initial processing of a message when the message does not reach the application. In this case, errors will be conveyed using an HTTP 4xx or 5xx, with an optional FHIR "Operation Outcome" resource to return detailed information. The request (claim, claim reversal, daily totals or adjudication details request) has not been accepted. Many of these errors are generated by the generic server framework.
Some common HTTP Status codes are:
- 400 Bad Request - resource could not be parsed or failed basic FHIR validation rules (or multiple matches were found for conditional criteria)
- 401 Unauthorized - authorization is required for the interaction that was attempted
- 404 Not Found - resource type not supported, or not a FHIR end-point
Validation Errors - FHIR validation error - eg missing/mandatory - structural errors
Application Level Errors
The following response are returned when the request reaches the application and is successfully processed, but errors are detected. These may be technical errors that are found by the application rather than as a pre-processing error (eg missing diagnosis code) or they may be business level errors (eg invalid provider id, unrecognized intervention code).
An Operation Outcome may be used as part of a message response, usually when the message has not been processed correctly.
Review, TWG - do we want a bundle, MH OR an Operation Outcome?
| Request | Error Response | FHIR Profile TBD, Add Links |
|---|---|---|
| Claim | HTTP 200, with Bundle, MH and Claim Response resource with an error data element? | ClaimResponse-Error |
| Claim reversal | HTTP 200, with Bundle, MH and an Operation Outcome resource with errors | Operation Outcome |
| Daily Totals | HTTP 200, with Bundle, MH and and an Operation Outcome resource with errors | Operation Outcome |
| Adjudication Details | HTTP 200, and an Operation Outcome resource with errors | Operation Outcome |
Network Errors
If a networking error should occur, it is not necessary to construct a claim response. If the error is due to issues with authorization, a bad URL or no communicaton with the switch, this should generate an HTTP error. Otherwise, a FHIR response may be used with an Operation Outcome detailing the issue.
This would be an HTTP 200, with Bundle, MH and and an Operation Outcome resource with errors. It is expected that the claim will be re-submitted at a later point in time.
Operations Outcome Profile
This will be a standard profile used across all messages.
| FHIR Data Element | Notes |
|---|---|
| Status | value= Error |
| Code | Error code value set - TBD |
| Details | text |
Example
Examples will be added over time and will be added here.