Use Pydantic FHIR types in tests.

Author: davidhamill1-nhs

.vscode/cspell-dictionary.txt

@@ -2,4 +2,5 @@ asid
 fhir
 getstructuredrecord
 gpconnect
+searchset
 usefixtures

gateway-api/src/fhir/__init__.py

@@ -1,6 +1,6 @@
 """FHIR data types and resources."""
 
-from fhir.bundle import Bundle, BundleEntry
+from fhir.bundle import BundleEntry, BundleTypedDict
 from fhir.general_practitioner import GeneralPractitioner
 from fhir.human_name import HumanName
 from fhir.identifier import Identifier
@@ -9,7 +9,7 @@
 from fhir.patient import PatientTypedDict
 
 __all__ = [
-    "Bundle",
+    "BundleTypedDict",
     "BundleEntry",
     "HumanName",
     "Identifier",

gateway-api/src/fhir/bundle.py

@@ -10,7 +10,7 @@ class BundleEntry(TypedDict):
     resource: PatientTypedDict
 
 
-class Bundle(TypedDict):
+class BundleTypedDict(TypedDict):
     resourceType: str
     id: str
     type: str

gateway-api/src/fhir/resources.py

@@ -36,6 +36,11 @@ def model_dump_json(self, *args: Any, **kwargs: Any) -> str:
         kwargs.setdefault("exclude_none", True)
         return super().model_dump_json(*args, **kwargs)
 
+    def model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]:
+        # FHIR resources should not return empty fields
+        kwargs.setdefault("exclude_none", True)
+        return super().model_dump(*args, **kwargs)
+
     @model_validator(mode="wrap")
     @classmethod
     def validate_with_subtype(
@@ -82,7 +87,7 @@ def _validate_resource_type(cls, value: str) -> str:
         return value
 
 
-type BundleType = Literal["document", "transaction", "searchset"]
+type BundleType = Literal["document", "transaction", "searchset", "collection"]
 
 
 class Bundle(Resource, resource_type="Bundle"):

gateway-api/src/gateway_api/conftest.py

@@ -6,8 +6,6 @@
 
 import pytest
 import requests
-from fhir import Bundle, OperationOutcome, PatientTypedDict
-from fhir.parameters import Parameters
 from flask import Request
 from requests.structures import CaseInsensitiveDict
 from werkzeug.test import EnvironBuilder
@@ -21,10 +19,12 @@ class FakeResponse:
 
     status_code: int
     headers: dict[str, str] | CaseInsensitiveDict[str]
-    _json: dict[str, Any] | PatientTypedDict | OperationOutcome | Bundle
+    _json: dict[str, Any]
     reason: str = ""
 
-    def json(self) -> dict[str, Any] | PatientTypedDict | OperationOutcome | Bundle:
+    def json(
+        self,
+    ) -> dict[str, Any]:
         return self._json
 
     def raise_for_status(self) -> None:
@@ -39,7 +39,7 @@ def text(self) -> str:
         return json.dumps(self._json)
 
 
-def create_mock_request(headers: dict[str, str], body: Parameters) -> Request:
+def create_mock_request(headers: dict[str, str], body: dict[str, Any]) -> Request:
     """Create a proper Flask Request object with headers and JSON body."""
     builder = EnvironBuilder(
         method="POST",
@@ -53,7 +53,7 @@ def create_mock_request(headers: dict[str, str], body: Parameters) -> Request:
 
 
 @pytest.fixture
-def valid_simple_request_payload() -> Parameters:
+def valid_simple_request_payload() -> dict[str, Any]:
     return {
         "resourceType": "Parameters",
         "parameter": [
@@ -69,7 +69,7 @@ def valid_simple_request_payload() -> Parameters:
 
 
 @pytest.fixture
-def valid_simple_response_payload() -> Bundle:
+def valid_simple_response_payload() -> dict[str, Any]:
     return {
         "resourceType": "Bundle",
         "id": "example-patient-bundle",
@@ -124,7 +124,7 @@ def valid_headers() -> dict[str, str]:
 
 
 @pytest.fixture
-def happy_path_pds_response_body() -> PatientTypedDict:
+def happy_path_pds_response_body() -> dict[str, Any]:
     return {
         "resourceType": "Patient",
         "id": "9999999999",

gateway-api/src/gateway_api/get_structured_record/request.py

@@ -18,7 +18,7 @@
 )
 
 if TYPE_CHECKING:
-    from fhir.bundle import Bundle
+    from fhir.bundle import BundleTypedDict
 
 
 class GetStructuredRecordRequest:
@@ -34,7 +34,7 @@ def __init__(self, request: Request) -> None:
         except BadRequest as error:
             raise InvalidRequestJSONError() from error
 
-        self._response_body: Bundle | OperationOutcome | None = None
+        self._response_body: BundleTypedDict | OperationOutcome | None = None
         self._status_code: int | None = None
 
         self._validate_headers()

gateway-api/src/gateway_api/get_structured_record/test_request.py

@@ -1,8 +1,7 @@
 import json
-from typing import TYPE_CHECKING, cast
+from typing import TYPE_CHECKING, Any, cast
 
 import pytest
-from fhir.parameters import Parameters
 from flask import Request
 
 from gateway_api.common.common import FlaskResponse
@@ -11,11 +10,11 @@
 from gateway_api.get_structured_record.request import GetStructuredRecordRequest
 
 if TYPE_CHECKING:
-    from fhir.bundle import Bundle
+    from fhir.bundle import BundleTypedDict
 
 
 @pytest.fixture
-def mock_request_with_headers(valid_simple_request_payload: Parameters) -> Request:
+def mock_request_with_headers(valid_simple_request_payload: dict[str, Any]) -> Request:
     headers = {
         "Ssp-TraceID": "test-trace-id",
         "ODS-from": "test-ods",
@@ -58,7 +57,7 @@ def test_nhs_number_is_pulled_from_request_body(
         assert actual == expected
 
     def test_raises_value_error_when_ods_from_header_is_missing(
-        self, valid_simple_request_payload: Parameters
+        self, valid_simple_request_payload: dict[str, Any]
     ) -> None:
         """Test that ValueError is raised when ODS-from header is missing."""
         headers = {
@@ -73,7 +72,7 @@ def test_raises_value_error_when_ods_from_header_is_missing(
             GetStructuredRecordRequest(request=mock_request)
 
     def test_raises_value_error_when_ods_from_header_is_whitespace(
-        self, valid_simple_request_payload: Parameters
+        self, valid_simple_request_payload: dict[str, Any]
     ) -> None:
         """
         Test that ValueError is raised when ODS-from header contains only whitespace.
@@ -91,7 +90,7 @@ def test_raises_value_error_when_ods_from_header_is_whitespace(
             GetStructuredRecordRequest(request=mock_request)
 
     def test_raises_value_error_when_trace_id_header_is_missing(
-        self, valid_simple_request_payload: Parameters
+        self, valid_simple_request_payload: dict[str, Any]
     ) -> None:
         """Test that ValueError is raised when Ssp-TraceID header is missing."""
         headers = {
@@ -106,7 +105,7 @@ def test_raises_value_error_when_trace_id_header_is_missing(
             GetStructuredRecordRequest(request=mock_request)
 
     def test_raises_value_error_when_trace_id_header_is_whitespace(
-        self, valid_simple_request_payload: Parameters
+        self, valid_simple_request_payload: dict[str, Any]
     ) -> None:
         """
         Test that ValueError is raised when Ssp-TraceID header contains only whitespace.
@@ -132,7 +131,7 @@ def test_sets_response_body_from_valid_json_data(
 
         request_obj = GetStructuredRecordRequest(request=mock_request_with_headers)
 
-        bundle_data: Bundle = {
+        bundle_data: BundleTypedDict = {
             "resourceType": "Bundle",
             "id": "test-bundle",
             "type": "collection",

gateway-api/src/gateway_api/pds/test_client.py

@@ -2,10 +2,10 @@
 Unit tests for :mod:`gateway_api.pds_search`.
 """
 
+from typing import Any
 from uuid import UUID, uuid4
 
 import pytest
-from fhir import PatientTypedDict
 from fhir.resources import Patient
 from pytest_mock import MockerFixture
 
@@ -17,7 +17,7 @@
 def test_search_patient_by_nhs_number_happy_path(
     auth_token: str,
     mocker: MockerFixture,
-    happy_path_pds_response_body: PatientTypedDict,
+    happy_path_pds_response_body: dict[str, Any],
 ) -> None:
     happy_path_response = FakeResponse(
         status_code=200, headers={}, _json=happy_path_pds_response_body
@@ -35,7 +35,7 @@ def test_search_patient_by_nhs_number_happy_path(
 def test_search_patient_by_nhs_number_has_no_gp_returns_gp_ods_code_none(
     auth_token: str,
     mocker: MockerFixture,
-    happy_path_pds_response_body: PatientTypedDict,
+    happy_path_pds_response_body: dict[str, Any],
 ) -> None:
     gp_less_response_body = happy_path_pds_response_body.copy()
     del gp_less_response_body["generalPractitioner"]
@@ -55,7 +55,7 @@ def test_search_patient_by_nhs_number_has_no_gp_returns_gp_ods_code_none(
 def test_search_patient_by_nhs_number_sends_expected_headers(
     auth_token: str,
     mocker: MockerFixture,
-    happy_path_pds_response_body: PatientTypedDict,
+    happy_path_pds_response_body: dict[str, Any],
 ) -> None:
     happy_path_response = FakeResponse(
         status_code=200, headers={}, _json=happy_path_pds_response_body
@@ -87,7 +87,7 @@ def test_search_patient_by_nhs_number_sends_expected_headers(
 def test_search_patient_by_nhs_number_generates_request_id(
     auth_token: str,
     mocker: MockerFixture,
-    happy_path_pds_response_body: PatientTypedDict,
+    happy_path_pds_response_body: dict[str, Any],
 ) -> None:
     happy_path_response = FakeResponse(
         status_code=200, headers={}, _json=happy_path_pds_response_body
@@ -128,7 +128,7 @@ def test_search_patient_by_nhs_number_not_found_raises_error(
 def test_search_patient_by_nhs_number_missing_nhs_number_raises_error(
     auth_token: str,
     mocker: MockerFixture,
-    happy_path_pds_response_body: PatientTypedDict,
+    happy_path_pds_response_body: dict[str, Any],
 ) -> None:
     response_body_missing_nhs_number = happy_path_pds_response_body.copy()
     response_body_missing_nhs_number["identifier"] = []

gateway-api/src/gateway_api/provider/test_client.py

@@ -10,7 +10,6 @@
 from typing import Any
 
 import pytest
-from fhir import Parameters
 from requests import Response
 from requests.structures import CaseInsensitiveDict
 from stubs.provider.stub import GpProviderStub
@@ -73,7 +72,7 @@ def dummy_jwt() -> JWT:
 
 def test_valid_gpprovider_access_structured_record_makes_request_correct_url_post_200(
     mock_request_post: dict[str, Any],
-    valid_simple_request_payload: Parameters,
+    valid_simple_request_payload: dict[str, Any],
     dummy_jwt: JWT,
 ) -> None:
     """
@@ -110,7 +109,7 @@ def test_valid_gpprovider_access_structured_record_makes_request_correct_url_pos
 
 def test_valid_gpprovider_access_structured_record_with_correct_headers_post_200(
     mock_request_post: dict[str, Any],
-    valid_simple_request_payload: Parameters,
+    valid_simple_request_payload: dict[str, Any],
     dummy_jwt: JWT,
 ) -> None:
     """
@@ -156,7 +155,7 @@ def test_valid_gpprovider_access_structured_record_with_correct_headers_post_200
 
 def test_valid_gpprovider_access_structured_record_with_correct_body_200(
     mock_request_post: dict[str, Any],
-    valid_simple_request_payload: Parameters,
+    valid_simple_request_payload: dict[str, Any],
     dummy_jwt: JWT,
 ) -> None:
     """
@@ -191,7 +190,7 @@ def test_valid_gpprovider_access_structured_record_with_correct_body_200(
 def test_valid_gpprovider_access_structured_record_returns_stub_response_200(
     mock_request_post: dict[str, Any],  # NOQA ARG001 (Mock not called directly)
     stub: GpProviderStub,
-    valid_simple_request_payload: Parameters,
+    valid_simple_request_payload: dict[str, Any],
     dummy_jwt: JWT,
 ) -> None:
     """
@@ -227,7 +226,7 @@ def test_valid_gpprovider_access_structured_record_returns_stub_response_200(
 
 def test_access_structured_record_raises_external_service_error(
     mock_request_post: dict[str, Any],  # NOQA ARG001 (Mock not called directly)
-    valid_simple_request_payload: Parameters,
+    valid_simple_request_payload: dict[str, Any],
     dummy_jwt: JWT,
 ) -> None:
     """
@@ -257,7 +256,7 @@ def test_access_structured_record_raises_external_service_error(
 
 def test_gpprovider_client_includes_authorization_header_with_bearer_token(
     mock_request_post: dict[str, Any],
-    valid_simple_request_payload: Parameters,
+    valid_simple_request_payload: dict[str, Any],
     dummy_jwt: JWT,
 ) -> None:
     """

gateway-api/src/gateway_api/test_app.py

@@ -4,11 +4,9 @@
 import os
 from collections.abc import Generator
 from copy import copy
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 import pytest
-from fhir.bundle import Bundle
-from fhir.parameters import Parameters
 from flask import Flask
 from flask.testing import FlaskClient
 from pytest_mock import MockerFixture
@@ -58,7 +56,7 @@ class TestGetStructuredRecord:
     def test_valid_get_structured_record_request_returns_expected_bundle(
         self,
         get_structured_record_response: Flask,
-        valid_simple_response_payload: Bundle,
+        valid_simple_response_payload: dict[str, Any],
     ) -> None:
         actual_bundle = get_structured_record_response.get_json()
         assert actual_bundle == valid_simple_response_payload
@@ -182,7 +180,7 @@ def test_get_structured_record_returns_internal_server_error_when_invalid_json_s
     def get_structured_record_response(
         client: FlaskClient[Flask],
         valid_headers: dict[str, str],
-        valid_simple_request_payload: Parameters,
+        valid_simple_request_payload: dict[str, Any],
     ) -> Flask:
         response = client.post(
             "/patient/$gpc.getstructuredrecord",
@@ -196,7 +194,7 @@ def get_structured_record_response(
     def get_structured_record_response_from_missing_header(
         client: FlaskClient[Flask],
         missing_headers: dict[str, str],
-        valid_simple_request_payload: Parameters,
+        valid_simple_request_payload: dict[str, Any],
     ) -> Flask:
         response = client.post(
             "/patient/$gpc.getstructuredrecord",
@@ -225,7 +223,7 @@ def get_structured_record_response_using_invalid_json_body(
     def mock_positive_return_value_from_controller_run(
         mocker: MockerFixture,
         valid_headers: dict[str, str],
-        valid_simple_response_payload: Bundle,
+        valid_simple_response_payload: dict[str, Any],
     ) -> None:
         postive_response = FlaskResponse(
             status_code=200,