-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathServiceUnavailable.yaml
More file actions
23 lines (21 loc) · 1.55 KB
/
ServiceUnavailable.yaml
File metadata and controls
23 lines (21 loc) · 1.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
description: |
Where status code 503 (Service Unavailable) is returned then an [NHSDigital-OperationOutcome](https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome) will be included in the body, as detailed below.
In response to receiving this status code, it is recommended that clients retry at a later time based on a returned `Retry-After` header when provided.
| issue.details.coding.code | issue.code | Coding System | Description |
| ------------------------- | ---------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| REC_UNAVAILABLE | transient | [BaRS Error Code](https://fhir.nhs.uk/CodeSystem/http-error-codes) | A request to an internal component timed out whilst attempting to serve a response or the system is currently otherwise unavailable. |
headers:
X-Correlation-ID:
$ref: '../headers/response/CorrelationID.yaml'
X-Request-ID:
$ref: '../headers/response/RequestID.yaml'
Content-Type:
$ref: '../headers/response/ContentTypeFhirJson.yaml'
Retry-After:
$ref: '../headers/response/RetryAfter.yaml'
content:
application/fhir+json:
schema:
$ref: '../NHSDigital-OperationOutcome.yaml'
example:
$ref: '../../examples/NHSDigital-OperationOutcome-503.json'