[GPCAPIM-275]: Harmonise the Controller, Flask entry point and Provider System modules

.devcontainer/devcontainer.json

@@ -18,7 +18,8 @@
         "ms-python.vscode-python-envs",
         "ms-python.mypy-type-checker",
         "sonarsource.sonarlint-vscode",
-        "alexkrechik.cucumberautocomplete"
+        "alexkrechik.cucumberautocomplete",
+        "streetsidesoftware.code-spell-checker"
       ],
       "extensions.ignoreRecommendations": true,
       "settings": {

.github/workflows/stage-2-test.yaml

@@ -3,6 +3,9 @@ name: "Test stage"
 env:
   BASE_URL: "http://localhost:5000"
   HOST: "localhost"
+  STUB_SDS: "true"
+  STUB_PDS: "true"
+  STUB_PROVIDER: "true"
 
 on:
   workflow_call:

.tool-versions

@@ -1,6 +1,6 @@
 # This file is for you! Please, updated to the versions agreed by your team.
 
-terraform 1.14.0
+terraform 1.14.5
 pre-commit 3.6.0
 gitleaks 8.18.4
 
@@ -15,7 +15,7 @@ gitleaks 8.18.4
 # docker/ghcr.io/make-ops-tools/gocloc latest@sha256:6888e62e9ae693c4ebcfed9f1d86c70fd083868acb8815fe44b561b9a73b5032 # SEE: https://github.com/make-ops-tools/gocloc/pkgs/container/gocloc
 # docker/ghcr.io/nhs-england-tools/github-runner-image 20230909-321fd1e-rt@sha256:ce4fd6035dc450a50d3cbafb4986d60e77cb49a71ab60a053bb1b9518139a646 # SEE: https://github.com/nhs-england-tools/github-runner-image/pkgs/container/github-runner-image
 # docker/hadolint/hadolint 2.12.0-alpine@sha256:7dba9a9f1a0350f6d021fb2f6f88900998a4fb0aaf8e4330aa8c38544f04db42 # SEE: https://hub.docker.com/r/hadolint/hadolint/tags
-# docker/hashicorp/terraform 1.12.2@sha256:b3d13c9037d2bd858fe10060999aa7ca56d30daafe067d7715b29b3d4f5b162f # SEE: https://hub.docker.com/r/hashicorp/terraform/tags
+# docker/hashicorp/terraform 1.14.5@sha256:96d2bc440714bf2b2f2998ac730fd4612f30746df43fca6f0892b2e2035b11bc # SEE: https://hub.docker.com/r/hashicorp/terraform/tags
 # docker/koalaman/shellcheck latest@sha256:e40388688bae0fcffdddb7e4dea49b900c18933b452add0930654b2dea3e7d5c # SEE: https://hub.docker.com/r/koalaman/shellcheck/tags
 # docker/mstruebing/editorconfig-checker 2.7.1@sha256:dd3ca9ea50ef4518efe9be018d669ef9cf937f6bb5cfe2ef84ff2a620b5ddc24 # SEE: https://hub.docker.com/r/mstruebing/editorconfig-checker/tags
 # docker/sonarsource/sonar-scanner-cli 10.0@sha256:0bc49076468d2955948867620b2d98d67f0d59c0fd4a5ef1f0afc55cf86f2079 # SEE: https://hub.docker.com/r/sonarsource/sonar-scanner-cli/tags

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+
+        {
+            "name": "Run Gateway API",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/gateway-api/src/gateway_api/app.py",
+            "envFile": "${workspaceFolder}/.env",
+            "jinja": true,
+            "console": "integratedTerminal"
+        }
+    ]
+}

.vscode/settings.json

@@ -60,5 +60,17 @@
     "projectKey": "NHSDigital_clinical-data-gateway-api"
   },
   // Disabling automatic port forwarding as the devcontainer should already have access to any required ports.
-  "remote.autoForwardPorts": false
+  "remote.autoForwardPorts": false,
+
+  // Code spell checker configuration
+  "cSpell.language": "en-GB",
+  "cSpell.words": [
+    "asid",
+    "fhir",
+    "getstructuredrecord",
+    "gpconnect",
+    "usefixtures",
+  ],
+  "python-envs.defaultEnvManager": "ms-python.python:system",
+  "python-envs.pythonProjects": [],
 }

gateway-api/openapi.yaml

@@ -247,3 +247,28 @@ paths:
                         diagnostics:
                           type: string
                           example: "Internal server error"
+
+        '502':
+          description: Received an error response from a downstream server
+          content:
+            application/fhir+json:
+              schema:
+                type: object
+                properties:
+                  resourceType:
+                    type: string
+                    example: "OperationOutcome"
+                  issue:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        severity:
+                          type: string
+                          example: "error"
+                        code:
+                          type: string
+                          example: "exception"
+                        diagnostics:
+                          type: string
+                          example: "PDS FHIR API request failed: Bad Gateway"

gateway-api/pyproject.toml

@@ -55,6 +55,7 @@ dev = [
     "schemathesis>=4.4.1",
     "types-requests (>=2.32.4.20250913,<3.0.0.0)",
     "types-pyyaml (>=6.0.12.20250915,<7.0.0.0)",
+    "pytest-mock (>=3.15.1,<4.0.0)",
 ]
 
 [tool.mypy]

gateway-api/src/fhir/__init__.py

@@ -1,6 +1,7 @@
 """FHIR data types and resources."""
 
 from fhir.bundle import Bundle, BundleEntry
+from fhir.general_practitioner import GeneralPractitioner
 from fhir.human_name import HumanName
 from fhir.identifier import Identifier
 from fhir.operation_outcome import OperationOutcome, OperationOutcomeIssue
@@ -17,4 +18,5 @@
     "Parameter",
     "Parameters",
     "Patient",
+    "GeneralPractitioner",
 ]

gateway-api/src/fhir/general_practitioner.py

@@ -0,0 +1,21 @@
+"""FHIR GeneralPractitioner type."""
+
+from typing import TypedDict
+
+from fhir.period import Period
+
+
+class GeneralPractitionerIdentifier(TypedDict):
+    """Identifier for GeneralPractitioner with optional period."""
+
+    system: str
+    value: str
+    period: Period
+
+
+class GeneralPractitioner(TypedDict):
+    """FHIR GeneralPractitioner reference."""
+
+    id: str
+    type: str
+    identifier: GeneralPractitionerIdentifier

gateway-api/src/fhir/human_name.py

@@ -2,8 +2,11 @@
 
 from typing import TypedDict
 
+from fhir.period import Period
+
 
 class HumanName(TypedDict):
     use: str
     family: str
     given: list[str]
+    period: Period

gateway-api/src/fhir/patient.py

@@ -1,7 +1,8 @@
 """FHIR Patient resource."""
 
-from typing import TypedDict
+from typing import NotRequired, TypedDict
 
+from fhir.general_practitioner import GeneralPractitioner
 from fhir.human_name import HumanName
 from fhir.identifier import Identifier
 
@@ -13,3 +14,4 @@ class Patient(TypedDict):
     name: list[HumanName]
     gender: str
     birthDate: str
+    generalPractitioner: NotRequired[list[GeneralPractitioner]]