Skip to content

Commit f10c3a2

Browse files
nhsd-david-wassnhsd-david-wass
committed
[ERSSUP-83710]-[AO]-[Update 401 and 403 error descriptions]-[DMW]
1 parent 5d75bb7 commit f10c3a2

File tree

5 files changed

+51
-7
lines changed

5 files changed

+51
-7
lines changed

‎sandbox/src/mocks/stu3/STU3-Unauthorised.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": "login",
12+
"details": {
13+
"coding": [
14+
{
15+
"system": "https://fhir.nhs.uk/STU3/CodeSystem/eRS-APIErrorCode-1",
16+
"code": "NO_ACCESS"
17+
}
18+
]
19+
},
20+
"diagnostics": "Example diagnostics message."
21+
}
22+
]
23+
}

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ description: |
55
| issue.details.coding.code | issue.code | Coding System | Description |
66
| ------------------------- | ---------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
77
| REC_FORBIDDEN | forbidden | [BaRS Error Code](https://fhir.nhs.uk/CodeSystem/http-error-codes) | A call attempts to access or operate upon a resource without proper authorisation. |
8+
| ACCESS_DENIED | forbidden | [APIM Error Code](https://fhir.nhs.uk/CodeSystem/NHSD-API-ErrorOrWarningCode) | The request could not be authenticated due to insufficient credentials being provided. |
89
910
headers:
1011
X-Correlation-ID:
@@ -18,4 +19,4 @@ content:
1819
schema:
1920
$ref: '../NHSDigital-OperationOutcome.yaml'
2021
example:
21-
$ref: '../../examples/NHSDigital-OperationOutcome-403.json'
22+
$ref: '../../examples/NHSDigital-OperationOutcome-403.json'

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: |
44
55
| issue.details.coding.code | issue.code | Coding System | Description |
66
| ------------------------- | ---------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7-
| ACCESS_DENIED | login | [APIM Error Code](https://fhir.nhs.uk/CodeSystem/NHSD-API-ErrorOrWarningCode) | The request could not be authenticated due to either no credentials being provided or the provided credentials no longer being valid. Callers receiving this code should reauthenticate. |
7+
| ACCESS_DENIED | <ul><li>login</li><li>forbidden</li></ul> | [APIM Error Code](https://fhir.nhs.uk/CodeSystem/NHSD-API-ErrorOrWarningCode) | The request could not be authenticated due to either no credentials being provided or the provided credentials no longer being valid. Callers receiving this code should reauthenticate. |
88
headers:
99
X-Correlation-ID:
1010
$ref: '../headers/response/CorrelationID.yaml'
@@ -15,4 +15,4 @@ content:
1515
schema:
1616
$ref: '../NHSDigital-OperationOutcome.yaml'
1717
example:
18-
$ref: '../../examples/NHSDigital-OperationOutcome-401.json'
18+
$ref: '../../examples/NHSDigital-OperationOutcome-401.json'

‎specification/components/stu3/schemas/responses/Forbidden.yaml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ description: |
22
Where status code 403 (Forbidden) is returned then an eRS-OperationOutcome-1 will be included in the body, as detailed below.
33
Check diagnostics property for specific information regarding the error.
44
5-
| Error code | Description |
6-
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
7-
| FORBIDDEN | Access Forbidden. |
5+
| issue.details.coding.code | issue.code | Coding System | Description |
6+
| ------------------------- | ---------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
7+
| FORBIDDEN | forbidden | [eRS Error Code](https://fhir.nhs.uk/CodeSystem/ers-error-codes) | A call attempts to access or operate upon a resource without proper authorisation. |
8+
| NO_ACCESS | forbidden | [eRS Error Code](https://fhir.nhs.uk/CodeSystem/ers-error-codes) | The request could not be authenticated due to insufficient credentials being provided. |
89
headers:
910
X-Correlation-ID:
1011
$ref: '../headers/response/CorrelationID.yaml'

‎specification/components/stu3/schemas/responses/Unauthorized.yaml‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
description: Unauthorized
1+
description: |
2+
Where status code 401 (Unauthorised) is returned then an eRS-OperationOutcome-1 will be included in the body, as detailed below.
3+
Check diagnostics property for specific information regarding the error.
4+
5+
| issue.details.coding.code | issue.code | Coding System | Description |
6+
| ------------------------- | ---------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
7+
| NO_ACCESS | <ul><li>login</li><li>forbidden</li></ul> | [eRS Error Code](https://fhir.nhs.uk/CodeSystem/ers-error-codes) | The request could not be authenticated due to either no credentials being provided or the provided credentials no longer being valid. Callers receiving this code should reauthenticate. |
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: '../STU3-OperationOutcome.yaml'
19+
example:
20+
$ref: '../../examples/STU3-Unauthorised.json'

0 commit comments

Comments
 (0)