NPA-4474 Change Invalid Value to Invalid Parameter

JackPlowman · JackPlowman · commit 767b181d4891 · 2025-03-03T13:40:31.000Z
diff --git a/sandbox/api/app.py b/sandbox/api/app.py
@@ -5,37 +5,22 @@
 
 from .constants import (
     INTERNAL_SERVER_ERROR_EXAMPLE,
+    QUESTIONNAIRE_RESPONSE__SUCCESS,
     RELATED__LIST_RELATIONSHIP,
     RELATED__LIST_RELATIONSHIP_WITH_INCLUDE,
-    INVALIDATED_RESOURCE,
-    QUESTIONNAIRE_RESPONSE__SUCCESS,
     RELATED__VERIFY_RELATIONSHIP_09,
-    RELATED__VERIFY_RELATIONSHIP_25,
     RELATED__VERIFY_RELATIONSHIP_09_WITH_INCLUDE,
+    RELATED__VERIFY_RELATIONSHIP_25,
     RELATED__VERIFY_RELATIONSHIP_25_WITH_INCLUDE,
-    CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
-    CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
-    CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
-    CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH,
-    CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH,
-    CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER,
-    CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT,
-    CONSENT__MULTIPLE_RELATIONSHIPS,
-    CONSENT__NO_RELATIONSHIPS,
-    CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
-    CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
-    CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE,
 )
+from .get_consent import get_consent_response
 from .utils import (
     check_for_empty,
-    check_for_consent_errors,
-    check_for_related_person_errors,
     check_for_list,
+    check_for_related_person_errors,
     check_for_validate,
     generate_response_from_example,
     remove_system,
-    check_for_consent_include_params,
-    check_for_consent_filtering,
 )
 
 app = Flask(__name__)
@@ -134,53 +119,4 @@ def get_consent() -> Union[dict, tuple]:
     Returns:
         Union[dict, tuple]: Response for GET /Consent
     """
-    try:
-        # Check Headers
-        if errors := check_for_consent_errors(request):
-            return errors
-
-        performer_identifier = remove_system(request.args.get("performer:identifier"))
-        status = request.args.getlist("status")
-        _include = request.args.getlist("_include")
-
-        # Single consenting adult relationship
-        if performer_identifier == "9000000010":
-            return check_for_consent_include_params(
-                _include,
-                CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
-                CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
-            )
-        # Single mother child relationship
-        elif performer_identifier == "9000000019":
-            return check_for_consent_include_params(
-                _include,
-                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
-                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH,
-            )
-        # Filtering
-        elif performer_identifier == "9000000017":
-            return check_for_consent_filtering(
-                status,
-                _include,
-                CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
-                CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
-                CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE,
-            )
-        elif performer_identifier == "9000000022":
-            return check_for_consent_include_params(
-                _include,
-                CONSENT__MULTIPLE_RELATIONSHIPS,
-                CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH,
-                CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT,
-                CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER,
-            )
-        # No relationships
-        elif performer_identifier == "9000000025":
-            return generate_response_from_example(CONSENT__NO_RELATIONSHIPS, 200)
-        else:
-            logger.error("Performer identifier does not match examples")
-            return generate_response_from_example(INVALIDATED_RESOURCE, 404)
-
-    except Exception as e:
-        logger.error(e)
-        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
+    return get_consent_response()
diff --git a/sandbox/api/get_consent.py b/sandbox/api/get_consent.py
@@ -0,0 +1,89 @@
+from logging import INFO, basicConfig, getLogger
+from typing import Union
+
+from flask import request
+
+from .constants import (
+    CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
+    CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
+    CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE,
+    CONSENT__MULTIPLE_RELATIONSHIPS,
+    CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH,
+    CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT,
+    CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER,
+    CONSENT__NO_RELATIONSHIPS,
+    CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
+    CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
+    CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
+    CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH,
+    INTERNAL_SERVER_ERROR_EXAMPLE,
+    INVALIDATED_RESOURCE,
+)
+from .utils import (
+    check_for_consent_errors,
+    check_for_consent_filtering,
+    check_for_consent_include_params,
+    generate_response_from_example,
+    remove_system,
+)
+
+basicConfig(level=INFO, format="%(asctime)s - %(message)s")
+logger = getLogger(__name__)
+
+
+def get_consent_response() -> Union[dict, tuple]:
+    """Sandbox API for GET /Consent
+
+    Returns:
+        Union[dict, tuple]: Response for GET /Consent
+    """
+    try:
+        # Check Headers
+        if errors := check_for_consent_errors(request):
+            return errors
+
+        performer_identifier = remove_system(request.args.get("performer:identifier"))
+        status = request.args.getlist("status")
+        _include = request.args.getlist("_include")
+
+        # Single consenting adult relationship
+        if performer_identifier == "9000000010":
+            return check_for_consent_include_params(
+                _include,
+                CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
+                CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
+            )
+        # Single mother child relationship
+        elif performer_identifier == "9000000019":
+            return check_for_consent_include_params(
+                _include,
+                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
+                CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP_INCLUDE_BOTH,
+            )
+        # Filtering
+        elif performer_identifier == "9000000017":
+            return check_for_consent_filtering(
+                status,
+                _include,
+                CONSENT__FILTERED_RELATIONSHIPS_STATUS_ACTIVE,
+                CONSENT__FILTERED_RELATIONSHIPS_STATUS_INACTIVE,
+                CONSENT__FILTERED_RELATIONSHIPS_STATUS_PROPOSED_ACTIVE,
+            )
+        elif performer_identifier == "9000000022":
+            return check_for_consent_include_params(
+                _include,
+                CONSENT__MULTIPLE_RELATIONSHIPS,
+                CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_BOTH,
+                CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PATIENT,
+                CONSENT__MULTIPLE_RELATIONSHIPS_INCLUDE_PERFORMER,
+            )
+        # No relationships
+        elif performer_identifier == "9000000025":
+            return generate_response_from_example(CONSENT__NO_RELATIONSHIPS, 200)
+        else:
+            logger.error("Performer identifier does not match examples")
+            return generate_response_from_example(INVALIDATED_RESOURCE, 404)
+
+    except Exception:
+        logger.exception("An error occurred while processing the request")
+        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
diff --git a/sandbox/api/tests/test_utils.py b/sandbox/api/tests/test_utils.py
@@ -5,10 +5,10 @@
 from flask import Response
 
 from ..utils import load_json_file
-from .conftest import RELATED_PERSON_API_ENDPOINT, CONSENT_API_ENDPOINT
+from .conftest import CONSENT_API_ENDPOINT, RELATED_PERSON_API_ENDPOINT
 
 FILE_PATH = "sandbox.api.utils"
-
+GET_CONSENT_FILE_PATH = "sandbox.api.get_consent"
 
 @pytest.mark.parametrize(
     "request_args,response_file_name,status_code",
@@ -114,12 +114,12 @@ def test_related_person__not_found(
         (
             "performer:identifier=9000000017&status=test",  # Invalid status parameter error
             "./api/examples/GET_Consent/errors/invalid-status-parameter.yaml",
-            400,
+            422,
         ),
         (
             "performer:identifier=9000000019&_include=test",  # Invalid include parameter error
             "./api/examples/errors/invalid-include-parameter.yaml",
-            400,
+            422,
         ),
     ],
 )
@@ -207,7 +207,7 @@ def test_check_for_related_person_errors(
         (
             "performer:identifier=90000009990",  # Invalid performer identifier
             "./api/examples/GET_Consent/errors/invalid-identifier.yaml",
-            400,
+            422,
         ),
         (
             "",  # missing performer identifier
@@ -217,11 +217,11 @@ def test_check_for_related_person_errors(
         (
             "performer:identifier=https://fhir.nhs.uk/Id/nhs-number|A730675929",  # identifier system invalid
             "./api/examples/GET_Consent/errors/invalid-identifier-system.yaml",
-            400,
+            422,
         ),
     ],
 )
-@patch(f"{FILE_PATH}.generate_response_from_example")
+@patch(f"{GET_CONSENT_FILE_PATH}.generate_response_from_example")
 def test_check_for_consent_errors(
     mock_generate_response_from_example: MagicMock,
     request_args: str,
diff --git a/sandbox/api/utils.py b/sandbox/api/utils.py
@@ -1,25 +1,25 @@
-from logging import getLogger
 from json import dumps, load
-from typing import Any, Optional, List
+from logging import getLogger
+from typing import Any, List, Optional
 
-from flask import Response, Request
+from flask import Request, Response
 from yaml import CLoader as Loader
 from yaml import load as yaml_load
 
 from .constants import (
+    BAD_REQUEST_INCLUDE_PARAM_INVALID,
+    CONSENT__STATUS_PARAM_INVALID,
+    CONSENT_PATIENT,
+    CONSENT_PERFORMER,
+    INCLUDE_FLAG,
+    INTERNAL_SERVER_ERROR_EXAMPLE,
+    INVALIDATED_RESOURCE,
+    PATIENT_IDENTIFIERS,
     RELATED__EMPTY_RESPONSE,
-    RELATED__ERROR_IDENTIFIER_MISSING,
     RELATED__ERROR_IDENTIFIER,
+    RELATED__ERROR_IDENTIFIER_MISSING,
     RELATED__ERROR_IDENTIFIER_SYSTEM,
-    PATIENT_IDENTIFIERS,
-    INVALIDATED_RESOURCE,
-    INCLUDE_FLAG,
     RELATED_IDENTIFIERS,
-    CONSENT_PERFORMER,
-    CONSENT_PATIENT,
-    INTERNAL_SERVER_ERROR_EXAMPLE,
-    CONSENT__STATUS_PARAM_INVALID,
-    BAD_REQUEST_INCLUDE_PARAM_INVALID,
 )
 
 FHIR_MIMETYPE = "application/fhir+json"
@@ -92,6 +92,11 @@ def check_for_consent_errors(request: Request) -> Optional[tuple]:
         return generate_response_from_example(
             f"{GET_CONSENT_ERRORS}/invalid-identifier-system.yaml", 422
         )
+    elif identifier_without_system == "9000000012":
+        # invalid status
+        return generate_response_from_example(
+            f"{GET_CONSENT_ERRORS}/gp-practice-not-found.yaml", 404
+        )
 
 
 def check_for_empty(identifier: str, patient_identifier: str) -> Response:
@@ -254,7 +259,7 @@ def check_for_consent_include_params(
     ):
         return generate_response_from_example(include_both_response_yaml, 200)
     else:
-        return generate_response_from_example(BAD_REQUEST_INCLUDE_PARAM_INVALID, 400)
+        return generate_response_from_example(BAD_REQUEST_INCLUDE_PARAM_INVALID, 422)
 
 
 def check_for_consent_filtering(
@@ -296,4 +301,4 @@ def check_for_consent_filtering(
             status_proposed_and_active_response_yaml, 200
         )
     else:
-        return generate_response_from_example(CONSENT__STATUS_PARAM_INVALID, 400)
+        return generate_response_from_example(CONSENT__STATUS_PARAM_INVALID, 422)
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier-system.yaml
@@ -1,5 +1,5 @@
 ConsentInvalidIdentifierSystemError:
-  summary: Bad request identifier system invalid
+  summary: Identifier system invalid
   description: 422 error response bundle for an invalid system of the identifier
   value:
     issue:
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml b/specification/examples/responses/GET_Consent/errors/invalid-identifier.yaml
@@ -1,5 +1,5 @@
 ConsentInvalidIdentifierError:
-  summary: Bad request invalid identifier
+  summary: Invalid identifier
   description: Error raised due to an invalid identifier request parameter being specified.
   value:
     issue:
diff --git a/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml b/specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml
@@ -1,13 +1,13 @@
 ConsentInvalidStatusParameterError:
-  summary: Bad request status param invalid
+  summary: status parameter invalid
   description: 422 error response bundle for an invalid status parameter
   value:
     issue:
       - code: invalid
         diagnostics: "Invalid request with error - status parameter is invalid."
         details:
           coding:
-            - code: "INVALID_VALUE"
+            - code: "INVALID_PARAMETER"
               display: "Required parameter(s) are invalid."
               system: "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode"
               version: "1"
diff --git a/specification/validated-relationships-service-api.yaml b/specification/validated-relationships-service-api.yaml
