Error Responses

This page documents the common error responses that may be returned when interacting with the RDC FHIR Server API.

HTTP Status Codes

The API uses standard HTTP status codes to indicate the success or failure of requests:

Error Response Format

All error responses follow the FHIR OperationOutcome format:

{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "diagnostics": "Detailed error message"
    }
  ]
}

Severity Values

The severity field can have the following values:

fatal - The issue caused the action to fail and no further checking could be performed

error - The issue is sufficiently important to cause the action to fail

warning - The issue is not important enough to cause the action to fail but may need attention

information - The issue has no effect on the action but is provided for informational purposes

Code values

The code field can have the following values:

• value - An element or header value is invalid
• not-found - The reference provided was not found
• forbidden - The user does not have the rights to perform this action
• exception - An unexpected internal error has occurred
• invalid - Content invalid against the specification or a profile
• transient - Transient processing issues (system may be able to resubmit)
• processing - Processing issues (final, no point resubmitting unchanged)
• not-supported - The system does not support the action or content requested

Diagnostics values

The diagnostics field provides a human-readable description of the error. It may include details such as:

• Invalid date format. Expected format: [ge|le]yyyy-MM-ddTHH:MM:SS[+|-]HH:MM
• The requested patient id is not found.
• Missing required parameter: subject
• Missing data sharing consent.