XCA error handling

NIR error handling is a technical guide to how error codes, error severities and HTTP statuses are determined and returned to the client.

The primary purpose of this document is to provide a technical reference for teams that are either developing or supporting NIR. However, it may also be used to inform content that will eventually be uploaded to the NIR API website.

Note: This is a living document and may be updated as new functionality and features are added to NIR - check with a member of the NIR delivery squad for the most up to date information.

In scope

1. How IHE error codes are consolidated and reported to the client from NIR.
2. How ResponseStatusType is determined.
3. How HTTP status codes are determined.
4. How error severity is determined.
5. Sample error messages.

Out of scope

1.  Specific instructions for how the requesting systems display or handle these errors.
2.  Guidance on what to do in the event of an incident.