Skip to content

Commit ce88a47

Browse files
nhsd-jack-wainwrightnhsd-jack-wainwright
committed
[ERSSUP-81706]-[DW]-[Adding 504 Gateway Timeout documentation for timeouts occuring in internal components]-[JW]
1 parent ac76f38 commit ce88a47

44 files changed

Lines changed: 165 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎sandbox/src/mocks/r4/NHSDigital-OperationOutcome-504.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"resourceType": "OperationOutcome",
3+
"meta": {
4+
"lastUpdated": "2022-03-01T10:00:00.42Z"
5+
},
6+
"issue": [
7+
{
8+
"severity": "error",
9+
"code": "timeout",
10+
"details": {
11+
"coding": [
12+
{
13+
"system": "https://fhir.nhs.uk/CodeSystem/http-error-codes",
14+
"code": "REC_GATEWAY_TIMEOUT"
15+
}
16+
]
17+
}
18+
}
19+
]
20+
}
21+

‎sandbox/src/mocks/stu3/STU3-GatewayTimeout.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"meta": {
3+
"profile": [
4+
"https://fhir.nhs.uk/STU3/StructureDefinition/eRS-OperationOutcome-1"
5+
]
6+
},
7+
"resourceType": "OperationOutcome",
8+
"issue": [
9+
{
10+
"severity": "error",
11+
"code": "timeout",
12+
"details": {
13+
"coding": [
14+
{
15+
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-APIErrorCode-1",
16+
"code": "GATEWAY_TIMEOUT",
17+
"display": "Gateway Timeout"
18+
}
19+
]
20+
}
21+
}
22+
]
23+
}

‎specification/components/r4/schemas/endpoints/a030-retrieve-business-functions.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,5 @@ responses:
111111
$ref: '../responses/TooManyRequests.yaml'
112112
'500':
113113
$ref: '../responses/InternalServerError.yaml'
114+
'504':
115+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/endpoints/a033-retrieve-healthcare-service.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,5 @@ responses:
6767
$ref: '../responses/TooManyRequests.yaml'
6868
'500':
6969
$ref: '../responses/InternalServerError.yaml'
70+
'504':
71+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/endpoints/a035-search-for-healthcare-services.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,5 @@ responses:
7777
$ref: '../responses/TooManyRequests.yaml'
7878
'500':
7979
$ref: '../responses/InternalServerError.yaml'
80+
'504':
81+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/endpoints/a037-retrieve-healthcare-service-version.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,5 @@ responses:
6464
$ref: '../responses/TooManyRequests.yaml'
6565
'500':
6666
$ref: '../responses/InternalServerError.yaml'
67+
'504':
68+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/endpoints/a040-retrieve-practitioner-info.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,5 @@
5555
$ref: '../responses/TooManyRequests.yaml'
5656
'500':
5757
$ref: '../responses/InternalServerError.yaml'
58+
'504':
59+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/endpoints/a041-search-service-request.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,5 @@ responses:
7979
$ref: '../responses/TooManyRequests.yaml'
8080
'500':
8181
$ref: '../responses/InternalServerError.yaml'
82+
'504':
83+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/endpoints/a042-retrieve-attachment.yaml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,6 @@ responses:
9494
'429':
9595
$ref: '../responses/TooManyRequests.yaml'
9696
'500':
97-
$ref: '../responses/InternalServerError.yaml'
97+
$ref: '../responses/InternalServerError.yaml'
98+
'504':
99+
$ref: '../responses/GatewayTimeout.yaml'

‎specification/components/r4/schemas/responses/GatewayTimeout.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
description: |
2+
Where status code 504 (Gateway Timeout) is returned then an [NHSDigital-OperationOutcome](https://fhir.nhs.uk/StructureDefinition/NHSDigital-OperationOutcome) will be included in the body, as detailed below.
3+
In response to receiving this status code, it is recommended that clients retry at a later time.
4+
5+
| issue.details.coding.code | issue.code | Coding System | Description |
6+
| ------------------------- | ---------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
7+
| REC_GATEWAY_TIMEOUT | timeout | [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. |
8+
headers:
9+
X-Correlation-ID:
10+
$ref: '../headers/response/CorrelationID.yaml'
11+
X-Request-ID:
12+
$ref: '../headers/response/RequestID.yaml'
13+
Content-Type:
14+
$ref: '../headers/response/ContentTypeFhirJson.yaml'
15+
content:
16+
application/fhir+json:
17+
schema:
18+
$ref: '../NHSDigital-OperationOutcome.yaml'
19+
example:
20+
$ref: '../../examples/NHSDigital-OperationOutcome-504.json'

0 commit comments

Comments
 (0)