Merge pull request #189 from NHSDigital/bug/NPA-4824/patch-consent-validate-status-code-request

NPA-4824: Add INVALID_STATUS_REASON Error

Author: LeoKHoward

sandbox/api/constants.py

@@ -59,6 +59,7 @@
 PATCH_CONSENT__INVALID_PATCH_FORMAT = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_patch_format.yaml"
 PATCH_CONSENT__INVALID_PATH = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_path.yaml"
 PATCH_CONSENT__INVALID_STATUS_CODE = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_status_code.yaml"
+PATCH_CONSENT__INVALID_STATUS_REASON = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_status_reason.yaml"
 PATCH_CONSENT__RESOURCE_NOT_FOUND = f"{PATCH_CONSENT__DIRECTORY}errors/resource_not_found.yaml"
 PATCH_CONSENT__INVALID_STATE_TRANSITION = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_state_transition.yaml"
 

sandbox/api/patch_consent.py

@@ -9,6 +9,7 @@
     PATCH_CONSENT__INVALID_STATUS_CODE,
     PATCH_CONSENT__RESOURCE_NOT_FOUND,
     PATCH_CONSENT__SUCCESS,
+    PATCH_CONSENT__INVALID_STATUS_REASON,
 )
 from .utils import generate_response_from_example
 
@@ -58,6 +59,10 @@ def patch_consent_response(identifier: str) -> Union[dict, tuple]:
             # Invalid state transition
             return generate_response_from_example(PATCH_CONSENT__INVALID_STATE_TRANSITION, 422)
 
+        elif identifier == "4b6792be":
+            # Invalid status reason
+            return generate_response_from_example(PATCH_CONSENT__INVALID_STATUS_REASON, 422)
+
         else:
             # Resource not found
             return generate_response_from_example(PATCH_CONSENT__RESOURCE_NOT_FOUND, 404)

sandbox/api/tests/test_patch_consent.py

@@ -11,6 +11,7 @@
     PATCH_CONSENT__INVALID_STATUS_CODE,
     PATCH_CONSENT__RESOURCE_NOT_FOUND,
     PATCH_CONSENT__SUCCESS,
+    PATCH_CONSENT__INVALID_STATUS_REASON,
 )
 
 CONSENT_API_ENDPOINT = "/FHIR/R4/Consent"
@@ -25,6 +26,7 @@
         ("3a2679eb", PATCH_CONSENT__INVALID_PATCH_FORMAT, 400),
         ("94df7c8f", PATCH_CONSENT__INVALID_PATH, 400),
         ("2a7b736d", PATCH_CONSENT__INVALID_STATUS_CODE, 422),
+        ("4b6792be", PATCH_CONSENT__INVALID_STATUS_REASON, 422),
         ("6fb4361b", PATCH_CONSENT__INVALID_STATE_TRANSITION, 422),
         ("xxxxxxxx", PATCH_CONSENT__RESOURCE_NOT_FOUND, 404),
         ("12345678", PATCH_CONSENT__RESOURCE_NOT_FOUND, 404),

specification/examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml

@@ -0,0 +1,15 @@
+PatchConsentInvalidStatusReasonError:
+  summary: Bad request invalid status reason
+  description: 422 error response for a request with an invalid status reason
+  value:
+    issue:
+      - code: invalid
+        diagnostics: "Invalid status reason."
+        details:
+          coding:
+            - code: "INVALID_STATUS_REASON"
+              display: "Status reason is invalid."
+              system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
+              version: '1'
+        severity: error
+    resourceType: "OperationOutcome"

specification/validated-relationships-service-api.yaml

@@ -723,6 +723,7 @@ paths:
         | Invalid patch format            | Malformed JSON patch document, request with id '3a2679eb'             | HTTP Status 400 and INVALID_PATCH_FORMAT error response       |
         | Invalid path                    | Patch targeting non-existent element, request with id '94df7c8f'      | HTTP Status 400 and INVALID_PATCH_PATH error response         |
         | Invalid status code             | Patch with invalid status value, request with id '2a7b736d'           | HTTP Status 422 and INVALID_STATUS_CODE error response        |
+        | Invalid status reason             | Patch with invalid status reason value, request with id '4b6792be'           | HTTP Status 422 and INVALID_STATUS_REASON error response        |
         | Resource not found              | Patch for non-existent Consent, request with an id not listed here    | HTTP Status 404 and RESOURCE_NOT_FOUND error response         |
         | Invalid state transition        | Patch attempting invalid status change, request with id '6fb4361b'    | HTTP Status 422 and INVALID_STATE_TRANSITION error response   |
       parameters:
@@ -806,6 +807,7 @@ paths:
             | 415         | `UNSUPPORTED_MEDIA`         | Unsupported media type.                                                                                                                   |
             | 422         | `INVALID_PATCH_PATH`        | Invalid patch path.                                                                                                                       |
             | 422         | `INVALID_STATUS_CODE`       | Invalid status code.                                                                                                                      |
+            | 422         | `INVALID_STATUS_REASON`       | Invalid status reason.                                                                                                                      |
             | 422         | `INVALID_STATE_TRANSITION`  | Invalid state transition.                                                                                                                 |
             | 422         | `INVALID_LEGAL_BASIS_CODE`  | Invalid legal basis code.                                                                                                                 |
             | 422         | `INVALID_END_DATE`          | End date is invalid.                                                                                                                      |
@@ -823,6 +825,8 @@ paths:
                   $ref: "./examples/responses/PATCH_Consent/errors/invalid_path.yaml#/PatchConsentInvalidPathError"
                 patchConsentInvalidStatusCodeError:
                   $ref: "./examples/responses/PATCH_Consent/errors/invalid_status_code.yaml#/PatchConsentInvalidStatusCodeError"
+                PatchConsentInvalidStatusReasonError:
+                  $ref: "./examples/responses/PATCH_Consent/errors/invalid_status_reason.yaml#/PatchConsentInvalidStatusReasonError"
                 patchConsentInvalidStateTransitionError:
                   $ref: "./examples/responses/PATCH_Consent/errors/invalid_state_transition.yaml#/PatchConsentInvalidStateTransitionError"
         "5XX":