NPA-4474 Add proposal for new GET /Consent status codes

Author: JackPlowman

specification/validated-relationships-service-api.yaml

@@ -435,16 +435,17 @@ paths:
             | HTTP status | Error code                         | Description                                                                                                                               |
             | ----------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
             | 400         | `MISSING_VALUE`                    | Missing header parameter. For details, see the `diagnostics` field.                                                                       |
-            | 400         | `INVALID_VALUE`                    | Invalid header parameter. For details, see the `diagnostics` field.                                                                       |
-            | 400         | `INVALID_IDENTIFIER_SYSTEM`        | Invalid identifier system.                                                                                                                |
             | 400         | `MISSING_IDENTIFIER_VALUE`         | Missing performer NHS number.                                                                                                             |
-            | 400         | `INVALID_IDENTIFIER_VALUE`         | Malformed performer NHS number.                                                                                                           |
             | 400         | `NOT_SUPPORTED`                    | The request is not currently supported.                                                                                                   |
             | 401         | `ACCESS_DENIED`                    | Missing or invalid OAuth 2.0 bearer token in request.                                                                                     |
             | 403         | `FORBIDDEN`                        | Access denied to resource.                                                                                                                |
             | 404         | `INVALIDATED_RESOURCE`             | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved                                            |
+            | 404         | `GP_PRACTICE_NOT_FOUND`            | GP Practice not found                                                                                                                     |
             | 405         | `METHOD_NOT_ALLOWED`               | The method is not allowed.                                                                                                                |
             | 408         | `TIMEOUT`                          | Request timed out.                                                                                                                        |
+            | 422         | `INVALID_VALUE`                    | Invalid header parameter. For details, see the `diagnostics` field.                                                                       |
+            | 422         | `INVALID_IDENTIFIER_SYSTEM`        | Invalid identifier system.                                                                                                                |
+            | 422         | `INVALID_IDENTIFIER_VALUE`         | Malformed performer NHS number.                                                                                                           |
             | 429         | `THROTTLED`                        | You have exceeded your application's [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits). |
 
           content:
@@ -466,8 +467,15 @@ paths:
                   $ref: "./examples/responses/GET_Consent/errors/invalid-status-parameter.yaml#/ConsentInvalidStatusParameterError"
                 InvalidIncludeParameterError:
                   $ref: "./examples/responses/errors/invalid-include-parameter.yaml#/InvalidIncludeParameterError"
-        "500":
-          description: Internal server error
+        "5XX":
+          description: |
+            Errors will be returned for the first error encountered in the request. An error occurred as follows:
+
+            | HTTP status | Error code                         | Description                                                                                                                               |
+            | ----------- | ---------------------------------- | ------------------------------------------------------------ |
+            | 500         | `SERVER_ERROR`                     | An unexpected internal server error has occurred.            |
+            | 503         | `DOWNSTREAM_SERVICE_ERROR`         | A downsteam service has failed, request cannot be completed. |
+
           content:
             application/fhir+json:
               schema:
@@ -545,7 +553,7 @@ paths:
                   extension:
                     - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
                       valueCodeableConcept:
-                        coding: 
+                        coding:
                           - system: http://terminology.hl7.org/CodeSystem/consent-reason
                             code: TBC
                             display: TBC
@@ -594,7 +602,7 @@ paths:
                   extension:
                     - url: https://fhir.hl7.org.uk/StructureDefinition/Extension-statusReason
                       valueCodeableConcept:
-                        coding: 
+                        coding:
                           - system: http://terminology.hl7.org/CodeSystem/consent-reason
                             code: TBC
                             display: TBC
@@ -620,7 +628,7 @@ paths:
             application/fhir+json:
               schema:
                 $ref: "#/components/schemas/OperationOutcome"
-              examples: 
+              examples:
                 postConsentInvalidPerformerIdentifier:
                   $ref: "./examples/responses/POST_Consent/error.yaml#/PostConsentInvalidPerformerIdentifierError"
                 postConsentInvalidAccessLevel:
@@ -2001,7 +2009,7 @@ components:
           description: Model the status reason.
           items:
             $ref: "#/components/schemas/Extension"
-    
+
     Extension:
       type: object
       properties: