Merge pull request #6363 from NHSDigital/do-not-consume-placeholder-imms-api-values

Do not consume placeholder imms api values

Author: jf-x-dev

app/lib/fhir_mapper/location.rb

@@ -8,15 +8,17 @@ def initialize(location)
       @location = location
     end
 
+    UNKNOWN_IDENTIFIER = "X99999"
+
     class UnknownValueError < StandardError
     end
 
     def fhir_reference
       if school?
-        value = urn || "X99999"
+        value = urn || UNKNOWN_IDENTIFIER
         system = "https://fhir.hl7.org.uk/Id/urn-school-number"
       elsif clinic?
-        value = ods_code || "X99999"
+        value = ods_code || UNKNOWN_IDENTIFIER
         system = "https://fhir.nhs.uk/Id/ods-organization-code"
       else
         raise UnknownValueError, "Unsupported location type: #{type}"

app/lib/fhir_mapper/vaccination_record.rb

@@ -11,6 +11,9 @@ class VaccinationRecord
 
     MILLILITER_SUB_STRINGS = %w[ml millilitre milliliter].freeze
 
+    BATCH_EXPIRY_MIN = Date.new(Date.current.year - 100, 1, 1)
+    BATCH_EXPIRY_MAX = Date.new(Date.current.year + 100, 1, 1)
+
     def initialize(vaccination_record)
       @vaccination_record = vaccination_record
     end
@@ -84,7 +87,7 @@ def self.from_fhir_record(fhir_record, patient:)
 
       location_system = fhir_record.location.identifier.system
       location_value = fhir_record.location.identifier.value
-      unless location_value == "X99999"
+      unless location_value == FHIRMapper::Location::UNKNOWN_IDENTIFIER
         case location_system
         when "https://fhir.hl7.org.uk/Id/urn-school-number"
           attrs[:location] = ::Location.find_by(urn: location_value)
@@ -94,10 +97,19 @@ def self.from_fhir_record(fhir_record, patient:)
       end
 
       if attrs[:location].nil?
-        attrs[:location_name] = fhir_record.location.identifier.value
+        attrs[:location_name] = (
+          if location_value == FHIRMapper::Location::UNKNOWN_IDENTIFIER
+            "Unknown"
+          else
+            location_value
+          end
+        )
       end
 
-      attrs[:performed_ods_code] = org_performer_ods_code_from_fhir(fhir_record)
+      performer_ods_code = org_performer_ods_code_from_fhir(fhir_record)
+      unless performer_ods_code == FHIRMapper::Location::UNKNOWN_IDENTIFIER
+        attrs[:performed_ods_code] = performer_ods_code
+      end
 
       user_performer_name = user_performer_name_from_fhir(fhir_record)
       attrs[:performed_by_given_name] = user_performer_name&.given&.first
@@ -116,7 +128,11 @@ def self.from_fhir_record(fhir_record, patient:)
 
       attrs[:vaccine] = Vaccine.from_fhir_record(fhir_record)
       attrs[:batch_number] = fhir_record.lotNumber&.to_s
-      attrs[:batch_expiry] = fhir_record.expirationDate&.to_date
+
+      batch_expiry = fhir_record.expirationDate&.to_date
+      attrs[:batch_expiry] = batch_expiry if (
+        BATCH_EXPIRY_MIN...BATCH_EXPIRY_MAX
+      ).cover?(batch_expiry)
 
       if attrs[:vaccine]
         attrs[:disease_types] = attrs[:vaccine].disease_types

spec/lib/fhir_mapper/vaccination_record_spec.rb

@@ -546,6 +546,70 @@
         end
       end
 
+      describe "the parsed performed_ods_code value" do
+        subject { record.performed_ods_code }
+
+        before do
+          allow(
+            fhir_immunization
+              .performer
+              .find { it.actor&.type == "Organization" }
+              .actor
+              .identifier
+          ).to receive(:value).and_return(ods_code)
+        end
+
+        let(:fixture_file_name) { "fhir/flu/fhir_record_full.json" }
+
+        context "when the org performer ODS code is a real code" do
+          let(:ods_code) { "B0C4P" }
+
+          it { should eq "B0C4P" }
+        end
+
+        context "when the org performer ODS code is a placeholder" do
+          let(:ods_code) { FHIRMapper::Location::UNKNOWN_IDENTIFIER }
+
+          it { should be_nil }
+        end
+      end
+
+      describe "the parsed batch_expiry value" do
+        subject { record.batch_expiry }
+
+        let(:fixture_file_name) { "fhir/flu/fhir_record_full.json" }
+
+        before do
+          allow(fhir_immunization).to receive(:expirationDate).and_return(
+            expiration_date
+          )
+        end
+
+        context "when the expiry date is realistic" do
+          let(:expiration_date) { "2026-07-02" }
+
+          it { should eq Date.new(2026, 7, 2) }
+        end
+
+        context "when the expiry date is after 2100" do
+          let(:expiration_date) { "9999-12-31" }
+
+          it { should be_nil }
+        end
+
+        context "when the expiry date is before 1900" do
+          let(:expiration_date) { "1899-12-31" }
+
+          it { should be_nil }
+        end
+
+        context "when the expiry date is nil" do
+          let(:expiration_date) { nil }
+
+          it { should be_nil }
+        end
+      end
+
       context "with a full fhir record" do
         let(:fixture_file_name) { "fhir/flu/fhir_record_full.json" }
 
@@ -740,7 +804,9 @@
         its(:delivery_method) { should eq "intramuscular" }
         its(:delivery_site) { should eq "left_arm_upper_position" }
         its(:full_dose) { should be true }
-        its(:location_name) { should eq "X99999" }
+
+        its(:location_name) { should eq "Unknown" }
+
         its(:outcome) { should eq "administered" }
         its(:performed_ods_code) { should eq "B0C4P" }
         its(:nhs_immunisations_api_primary_source) { should be true }
@@ -907,7 +973,8 @@
         its(:nhs_immunisations_api_primary_source) { should be true }
 
         its(:location) { should be_nil }
-        its(:location_name) { should eq "X99999" }
+
+        its(:location_name) { should eq "Unknown" }
 
         its(:notes) { should be_nil }
       end