VED-908: Update immunisation target parameter in Bundle.link URL. (#1008)

Author: mfjarvis

lambdas/backend/src/controller/constants.py

@@ -28,4 +28,4 @@ class IdentifierSearchElement(StrEnum):
     META = "meta"
 
 
-IMMUNIZATION_TARGET_LEGACY_KEY_NAME = "immunization-target"
+IMMUNIZATION_TARGET_LEGACY_KEY_NAME = "immunization.target"

lambdas/backend/src/service/fhir_service.py

@@ -2,6 +2,7 @@
 import datetime
 import logging
 import os
+import urllib.parse
 import uuid
 from typing import Optional, cast
 from uuid import uuid4
@@ -366,28 +367,20 @@ def create_url_for_bundle_link(
         date_to: Optional[datetime.date],
         include: Optional[str],
     ) -> str:
-        """Creates url for the searchset Bundle Link. Existing logic always sorted the parameters in the given order
-        below, so this has been maintained"""
-        base_url = f"{get_service_url()}/Immunization?"
-        date_from_optional_part = (
-            f"{ImmunizationSearchParameterName.DATE_FROM}={date_from.isoformat()}&" if date_from is not None else ""
-        )
-        date_to_optional_part = (
-            f"{ImmunizationSearchParameterName.DATE_TO}={date_to.isoformat()}&" if date_to is not None else ""
-        )
-
-        # Temporarily maintaining this for backwards compatibility with imms history, but we should remove it
-        immunization_targets_part = f"{IMMUNIZATION_TARGET_LEGACY_KEY_NAME}={','.join(immunization_targets)}&"
-        optional_include_part = f"{ImmunizationSearchParameterName.INCLUDE}={include}&" if include is not None else ""
-        patient_identifier_part = (
-            f"{ImmunizationSearchParameterName.PATIENT_IDENTIFIER}={PATIENT_IDENTIFIER_SYSTEM}|{patient_nhs_number}"
-        )
-
-        return (
-            base_url
-            + date_from_optional_part
-            + date_to_optional_part
-            + immunization_targets_part
-            + optional_include_part
-            + patient_identifier_part
-        )
+        """Creates url for the searchset Bundle Link."""
+        params = {
+            # Temporarily maintaining this for backwards compatibility with imms history, but we should remove it
+            IMMUNIZATION_TARGET_LEGACY_KEY_NAME: ",".join(immunization_targets),
+            ImmunizationSearchParameterName.IMMUNIZATION_TARGET: ",".join(immunization_targets),
+            ImmunizationSearchParameterName.PATIENT_IDENTIFIER: f"{PATIENT_IDENTIFIER_SYSTEM}|{patient_nhs_number}",
+        }
+
+        if date_from:
+            params[ImmunizationSearchParameterName.DATE_FROM] = date_from.isoformat()
+        if date_to:
+            params[ImmunizationSearchParameterName.DATE_TO] = date_to.isoformat()
+        if include:
+            params[ImmunizationSearchParameterName.INCLUDE] = include
+
+        query = urllib.parse.urlencode(params)
+        return f"{get_service_url()}/Immunization?{query}"

lambdas/backend/tests/service/test_fhir_service.py

@@ -766,8 +766,10 @@ def test_search_immunizations_returns_results_as_a_search_bundle(self, mock_uuid
             result.link[0],
             BundleLink.construct(
                 relation="self",
-                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?immunization-target"
-                "=COVID&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9990548609",
+                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+                "?immunization.target=COVID"
+                "&-immunization.target=COVID"
+                "&patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9990548609",
             ),
         )
         # Will contain the matched immunization and then the referenced patient resource
@@ -819,9 +821,12 @@ def test_search_immunizations_filters_by_date_and_status(self, mock_uuid):
             result.link[0],
             BundleLink.construct(
                 relation="self",
-                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?-date.from=2021"
-                "-02-06&-date.to=2023-01-01&immunization-target=COVID&patient.identifier="
-                "https://fhir.nhs.uk/Id/nhs-number|9990548609",
+                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+                "?immunization.target=COVID"
+                "&-immunization.target=COVID"
+                "&patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9990548609"
+                "&-date.from=2021-02-06"
+                "&-date.to=2023-01-01",
             ),
         )
         # Will contain the matched immunization and then the referenced patient resource
@@ -857,8 +862,11 @@ def test_search_immunizations_adds_include_to_searched_url(self, mock_uuid):
             result.link[0],
             BundleLink.construct(
                 relation="self",
-                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?immunization-target"
-                "=COVID&_include=Patient.identifier&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9990548609",
+                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+                "?immunization.target=COVID"
+                "&-immunization.target=COVID"
+                "&patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9990548609"
+                "&_include=Patient.identifier",
             ),
         )
         # Will contain the matched immunization and then the referenced patient resource
@@ -889,8 +897,10 @@ def test_search_immunizations_returns_empty_bundle_when_no_results_found(self):
             result.link[0],
             BundleLink.construct(
                 relation="self",
-                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?immunization-target"
-                "=FLU&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9990548609",
+                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+                "?immunization.target=FLU"
+                "&-immunization.target=FLU"
+                "&patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9990548609",
             ),
         )
         self.assertEqual(len(result.entry), 0)
@@ -925,8 +935,10 @@ def test_search_immunizations_includes_an_error_outcome_within_results_if_client
             result.link[0],
             BundleLink.construct(
                 relation="self",
-                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?immunization-target"
-                "=COVID&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9990548609",
+                url="https://internal-dev.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
+                "?immunization.target=COVID"
+                "&-immunization.target=COVID"
+                "&patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9990548609",
             ),
         )
         # Will contain the matched immunization, the referenced patient resource and an OperationOutcome