Skip to content

Commit 0f5565a

Browse files
JackPlowmanJackPlowman
committed
NPA-4749 Add MULTIPLE_IDENTIFIER_PARAMETERS Error
1 parent 36a6af7 commit 0f5565a

File tree

2 files changed

+34
-16
lines changed

2 files changed

+34
-16
lines changed

‎specification/examples/responses/GET_Consent/errors/multiple-identifier-parameters.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
GetConsentMultipleIdentifierParametersError:
2+
summary: Multiple identifier parameters error
3+
description: 422 error response for a request with multiple identifier parameters
4+
value:
5+
issue:
6+
- code: invalid
7+
diagnostics: "Both 'performer:identifier' and 'patient:identifier' parameters cannot be used together."
8+
details:
9+
coding:
10+
- code: "MULTIPLE_IDENTIFIER_PARAMETERS"
11+
display: "Multiple identifiers provided."
12+
system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
13+
version: '1'
14+
severity: error
15+
resourceType: "OperationOutcome"

‎specification/validated-relationships-service-api.yaml‎

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -517,22 +517,23 @@ paths:
517517
description: |
518518
Errors will be returned for the first error encountered in the request. An error occurred as follows:
519519
520-
| HTTP status | Error code | Description |
521-
| ----------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
522-
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
523-
| 400 | `INVALID_VALUE` | Invalid header. For details, see the `diagnostics` field. |
524-
| 400 | `MISSING_IDENTIFIER_VALUE` | Missing performer:identifier or patient:identifier value. |
525-
| 400 | `NOT_SUPPORTED` | The request is not currently supported. |
526-
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
527-
| 403 | `FORBIDDEN` | Access denied to resource. |
528-
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |
529-
| 404 | `GP_PRACTICE_NOT_FOUND` | GP Practice not found. |
530-
| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |
531-
| 408 | `TIMEOUT` | Request timed out. |
532-
| 422 | `INVALID_IDENTIFIER_SYSTEM` | Invalid performer:identifier or patient:identifier identifier system. |
533-
| 422 | `INVALID_IDENTIFIER_VALUE` | Malformed performer:identifier or patient:identifier NHS number. |
534-
| 422 | `INVALID_PARAMETER` | Invalid parameter. For details, see the `diagnostics` field. |
535-
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
520+
| HTTP status | Error code | Description |
521+
| ----------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
522+
| 400 | `MISSING_VALUE` | Missing header or parameter. For details, see the `diagnostics` field. |
523+
| 400 | `INVALID_VALUE` | Invalid header. For details, see the `diagnostics` field. |
524+
| 400 | `MISSING_IDENTIFIER_VALUE` | Missing performer:identifier or patient:identifier value. |
525+
| 400 | `NOT_SUPPORTED` | The request is not currently supported. |
526+
| 401 | `ACCESS_DENIED` | Missing or invalid OAuth 2.0 bearer token in request. |
527+
| 403 | `FORBIDDEN` | Access denied to resource. |
528+
| 404 | `INVALIDATED_RESOURCE` | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved |
529+
| 404 | `GP_PRACTICE_NOT_FOUND` | GP Practice not found. |
530+
| 405 | `METHOD_NOT_ALLOWED` | The method is not allowed. |
531+
| 408 | `TIMEOUT` | Request timed out. |
532+
| 422 | `MULTIPLE_IDENTIFIER_PARAMETERS` | Both performer:identifier and patient:identifier parameters supplied which isn't supported. |
533+
| 422 | `INVALID_IDENTIFIER_SYSTEM` | Invalid performer:identifier or patient:identifier identifier system. |
534+
| 422 | `INVALID_IDENTIFIER_VALUE` | Malformed performer:identifier or patient:identifier NHS number. |
535+
| 422 | `INVALID_PARAMETER` | Invalid parameter. For details, see the `diagnostics` field. |
536+
| 429 | `THROTTLED` | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
536537
537538
content:
538539
application/fhir+json:
@@ -555,6 +556,8 @@ paths:
555556
$ref: "./examples/responses/GET_Consent/errors/gp-practice-not-found.yaml#/GPPracticeNotFoundError"
556557
InvalidIncludeParameterError:
557558
$ref: "./examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterError"
559+
ConsentMultipleIdentifierParametersError:
560+
$ref: "./examples/responses/GET_Consent/errors/multiple-identifier-parameters.yaml#/GetConsentMultipleIdentifierParametersError"
558561
"5XX":
559562
description: |
560563
Errors will be returned for the first error encountered in the request. An error occurred as follows:

0 commit comments

Comments
 (0)