Merge pull request #6614 from NHSDigital/alistair/imms-api-suppress-bundle-link-mismatch

Suppress warning for `immunization.target` mismatch

Author: alistair-white-horne-tng

app/lib/nhs/immunisations_api.rb

@@ -412,6 +412,11 @@ def check_bundle_link_params(bundle, request_params)
       uri = URI(link)
       bundle_params = URI.decode_www_form(uri.query).to_h
 
+      # The Imms API used to have a bug where they referred to `immunization.target` instead of `-immunization.target`.
+      # They have since fixed this, but they now include both versions in the `bundle.link` field. We must exclude the
+      # deprecated version from the comparison.
+      bundle_params.delete("immunization.target")
+
       # We don't care about the order of the target values
       bundle_params["-immunization.target"] = bundle_params[
         "-immunization.target"

spec/fixtures/files/fhir/search_responses/bad_immunization_target.json

@@ -4,7 +4,7 @@
   "link": [
     {
       "relation": "self",
-      "url": "https://int.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?immunization+target=3IN1,MMR,MMRV,FLU,HPV,MENACWY&_include=Immunization:patient&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9793826983"
+      "url": "https://int.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization?immunization+target=3IN1,MMR,MMRV,FLU,HPV,MENACWY&patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9793826983"
     }
   ],
   "entry": [

spec/fixtures/files/fhir/search_responses/immunization_target_both.json

@@ -4,7 +4,7 @@
   "link": [
     {
       "relation": "self",
-      "url": "https://int.api.service.nhs.uk/immunisation-fhir-api/Immunization?-date.from=2025-08-01\u0026-date.to=2025-10-01\u0026-immunization.target=FLU,HPV,MENACWY,3IN1,MMR,MMRV\u0026patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9449308357"
+      "url": "https://int.api.service.nhs.uk/immunisation-fhir-api/Immunization?-date.from=2025-08-01\u0026-date.to=2025-10-01\u0026-immunization.target=FLU,HPV,MENACWY,3IN1,MMR,MMRV\u0026immunization.target=FLU,HPV,MENACWY,3IN1,MMR,MMRV\u0026patient.identifier=https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9449308357"
     }
   ],
   "entry": [