Reference: OperationOutcome Errors

Understand FHIR OperationOutcome responses returned by DDFS endpoints.

OperationOutcome Responses

DDFS returns a FHIR OperationOutcome when an error response has a FHIR-formatted body. Review issue.severity, issue.code, details, and diagnostics to identify the cause.

FHIR canonical definition: http://hl7.org/fhir/StructureDefinition/OperationOutcome

Common HTTP Status Codes

StatusTypical meaning
400Malformed input or an unsupported parameter value.
401Missing, expired, or invalid bearer token.
403The token does not grant the required scope.
404The requested resource was not found or is not visible to the caller.
409The request conflicts with the current resource state.
410The requested resource has been deleted.
422The resource violates validation or business rules.
429The request was throttled.
500An unexpected server error occurred.
503The service is temporarily unavailable.

Example

(application/fhir+json)
{
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Invalid parameter value."
      }
    }
  ]
}