[GPCAPIM-338] Remove party key (#186)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description

This ticket removes support for use of a party key from the SDS client
and stub. It also adds a new interaction ID that is expected by the SDS
sandbox environment and uses that as default if the SDS sandbox
environment is selected.

Note that the location of the constant for the SDS sandbox interaction
ID isn't ideal. However, putting it in a sensible place in SDS causes a
circular reference, and we're removing support for sandbox anyway so
it'll be disappearing again shortly, so putting it alongside the
existing interaction ID seemed to make the most sense.

## Context

Use of party key was confusing, it wasn't clear what it was for or
whether it was necessary. It turns out not to be necessary, so removing
it makes the code cleaner and more maintainable.

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [X] Refactoring (non-breaking change)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Breaking change (fix or feature that would change existing
functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [X] I have followed the code style of the project
- [X] I have added tests to cover my changes
- [ ] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming
- [ ] Exceptions/Exclusions to coding standards (e.g. #noqa or #NOSONAR)
are included within this Pull Request.

---

## Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.

- [X] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.

Author: Vox-Ben

Makefile

@@ -75,6 +75,18 @@ deploy: clean build # Deploy the project artefact to the target environment @Pip
 	else \
 		$(docker) run --platform linux/amd64 --name gateway-api -p 5000:8080 $${ENVIRONMENT_STRING} -d ${IMAGE_NAME} ; \
 	fi
+	@max_attempts=5 ; \
+	attempt=1 ; \
+	while [[ $$attempt -le $$max_attempts ]]; do \
+		if $(docker) ps --filter "name=gateway-api" --filter "status=running" --format "{{.Names}}" | grep -q "^gateway-api$$"; then \
+			exit 0 ; \
+		fi ; \
+		sleep $$((attempt * 2)) ; \
+		attempt=$$((attempt + 1)) ; \
+	done ; \
+	echo "ERROR: gateway-api container failed to start. Logs:" ; \
+	$(docker) logs gateway-api ; \
+	exit 1
 
 clean:: stop # Clean-up project resources (main) @Operations
 	@echo "Removing Gateway API container..."

gateway-api/src/fhir/constants.py

@@ -11,5 +11,4 @@ class FHIRSystem(StrEnum):
     SDS_USER_ID = "https://fhir.nhs.uk/Id/sds-user-id"
     SDS_ROLE_PROFILE_ID = "https://fhir.nhs.uk/Id/sds-role-profile-id"
     NHS_SERVICE_INTERACTION_ID = "https://fhir.nhs.uk/Id/nhsServiceInteractionId"
-    NHS_MHS_PARTY_KEY = "https://fhir.nhs.uk/Id/nhsMhsPartyKey"
     NHS_SPINE_ASID = "https://fhir.nhs.uk/Id/nhsSpineASID"

gateway-api/src/fhir/r4/__init__.py

@@ -4,7 +4,6 @@
 from .elements.identifier import (
     ASIDIdentifier,
     OrganizationIdentifier,
-    PartyKeyIdentifier,
     PatientIdentifier,
     UUIDIdentifier,
 )
@@ -25,7 +24,6 @@
     "GeneralPractitioner",
     "OrganizationIdentifier",
     "Organization",
-    "PartyKeyIdentifier",
     "Patient",
     "PatientIdentifier",
     "Practitioner",

gateway-api/src/fhir/r4/elements/identifier.py

@@ -33,12 +33,6 @@ class ASIDIdentifier(Identifier, expected_system="https://fhir.nhs.uk/Id/nhsSpin
     """A FHIR R4 ASID Identifier."""
 
 
-class PartyKeyIdentifier(
-    Identifier, expected_system="https://fhir.nhs.uk/Id/nhsMhsPartyKey"
-):
-    """A FHIR R4 Party Key Identifier."""
-
-
 class AgnosticDeviceIdentifier(Identifier, expected_system="__unknown__"):
     """TODO [GPCAPIM-358]: define system once JWT Device details are understood."""
 

gateway-api/src/fhir/r4/resources/device.py

@@ -7,7 +7,6 @@
 from ..elements.identifier import (
     AgnosticDeviceIdentifier,
     ASIDIdentifier,
-    PartyKeyIdentifier,
 )
 
 
@@ -17,6 +16,6 @@ class Device(Resource, resource_type="Device"):
     model_config = ConfigDict(extra="allow")
 
     identifier: Annotated[
-        list[ASIDIdentifier | PartyKeyIdentifier | AgnosticDeviceIdentifier],
+        list[ASIDIdentifier | AgnosticDeviceIdentifier],
         Field(frozen=True, min_length=1),
     ]

gateway-api/src/fhir/r4/resources/test_resources.py

@@ -12,7 +12,6 @@
     Entry,
     GeneralPractitioner,
     OrganizationIdentifier,
-    PartyKeyIdentifier,
     Patient,
     PatientIdentifier,
     Practitioner,
@@ -375,46 +374,11 @@ def test_create_with_asid_identifier(self) -> None:
             "identifier value should match"
         )
 
-    def test_create_with_party_key_identifier(self) -> None:
-        device = Device.create(
-            identifier=[
-                PartyKeyIdentifier(
-                    system="https://fhir.nhs.uk/Id/nhsMhsPartyKey",
-                    value="P12345-000001",
-                )
-            ],
-        )
-
-        assert device.identifier[0].system == "https://fhir.nhs.uk/Id/nhsMhsPartyKey", (
-            "system should match the party key URI"
-        )
-
-    def test_create_with_mixed_identifiers(self) -> None:
-        device = Device.create(
-            identifier=[
-                ASIDIdentifier(
-                    system="https://fhir.nhs.uk/Id/nhsSpineASID",
-                    value="123",
-                ),
-                PartyKeyIdentifier(
-                    system="https://fhir.nhs.uk/Id/nhsMhsPartyKey",
-                    value="PK-1",
-                ),
-            ],
-        )
-
-        assert len(device.identifier) == 2, "should have two identifiers"
-
     def test_asid_identifier_expected_system(self) -> None:
         assert ASIDIdentifier._expected_system == (
             "https://fhir.nhs.uk/Id/nhsSpineASID"
         ), "_expected_system should be the ASID URI"
 
-    def test_party_key_identifier_expected_system(self) -> None:
-        assert PartyKeyIdentifier._expected_system == (
-            "https://fhir.nhs.uk/Id/nhsMhsPartyKey"
-        ), "_expected_system should be the party key URI"
-
 
 class TestDeviceModelValidate:
     def test_valid_device(self) -> None:

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

@@ -2,6 +2,7 @@
 
 from gateway_api.get_structured_record.request import (
     ACCESS_RECORD_STRUCTURED_INTERACTION_ID,
+    SDS_SANDBOX_INTERACTION_ID,
     GetStructuredRecordRequest,
 )
 from gateway_api.get_structured_record.response import GetStructuredRecordResponse
@@ -10,4 +11,5 @@
     "GetStructuredRecordRequest",
     "GetStructuredRecordResponse",
     "ACCESS_RECORD_STRUCTURED_INTERACTION_ID",
+    "SDS_SANDBOX_INTERACTION_ID",
 ]

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

@@ -18,6 +18,11 @@
     "urn:nhs:names:services:gpconnect:fhir:operation:gpc.getstructuredrecord-1"
 )
 
+# The SDS Sandbox environment only returns results for this interaction ID.
+# Non-sandbox environments should use ACCESS_RECORD_STRUCTURED_INTERACTION_ID.
+# TODO: Remove this once we no longer support sandbox (probably in GPCAPIM-396).
+SDS_SANDBOX_INTERACTION_ID = "urn:nhs:names:services:psis:REPC_IN150016UK05"
+
 
 class GetStructuredRecordRequest:
     INTERACTION_ID: ClassVar[str] = ACCESS_RECORD_STRUCTURED_INTERACTION_ID

gateway-api/src/gateway_api/sds/client.py

@@ -18,7 +18,10 @@
 from requests import HTTPError
 
 from gateway_api.common.error import SdsRequestFailedError
-from gateway_api.get_structured_record import ACCESS_RECORD_STRUCTURED_INTERACTION_ID
+from gateway_api.get_structured_record import (
+    ACCESS_RECORD_STRUCTURED_INTERACTION_ID,
+    SDS_SANDBOX_INTERACTION_ID,
+)
 from gateway_api.sds.search_results import SdsSearchResults
 
 # TODO [GPCAPIM-359]: Once stub servers/containers made for PDS, SDS and provider
@@ -86,11 +89,15 @@ def __init__(
     ) -> None:
         self.base_url = base_url.rstrip("/")
         self.timeout = timeout
-        self.service_interaction_id = (
-            service_interaction_id or self.DEFAULT_SERVICE_INTERACTION_ID
-        )
         self.api_key = self._get_api_key()
 
+        if service_interaction_id is not None:
+            self.service_interaction_id = service_interaction_id
+        elif self.base_url == self.SANDBOX_URL:
+            self.service_interaction_id = SDS_SANDBOX_INTERACTION_ID
+        else:
+            self.service_interaction_id = self.DEFAULT_SERVICE_INTERACTION_ID
+
     def _build_headers(self, correlation_id: str | None = None) -> dict[str, str]:
         """
         Build mandatory and optional headers for an SDS request.
@@ -134,9 +141,6 @@ def get_org_details(
             return empty_search_results
 
         asid = self._extract_device_identifier(device, FHIRSystem.NHS_SPINE_ASID)
-        party_key = self._extract_device_identifier(
-            device, FHIRSystem.NHS_MHS_PARTY_KEY
-        )
 
         # Step 2: Get Endpoint to obtain endpoint URL
         endpoint_url: str | None = None
@@ -146,7 +150,6 @@ def get_org_details(
 
         endpoint_bundle = self._query_sds(
             ods_code=ods_code,
-            party_key=party_key,
             correlation_id=correlation_id,
             timeout=timeout,
             querytype=SdsResourceType.ENDPOINT,
@@ -173,7 +176,6 @@ def _get_api_key() -> str:
     def _query_sds(
         self,
         ods_code: str,
-        party_key: str | None = None,
         correlation_id: str | None = None,
         timeout: int | None = 10,
         querytype: SdsResourceType = SdsResourceType.DEVICE,
@@ -191,9 +193,6 @@ def _query_sds(
             ],
         }
 
-        if party_key is not None:
-            params["identifier"].append(f"{FHIRSystem.NHS_MHS_PARTY_KEY}|{party_key}")
-
         response = get(
             url,
             headers=headers,