Merge pull request #5742 from nhsuk/sync-national-reporting-vaccinations-mav-2733

Sync national reporting vaccinations to NHS Immunisations API

Author: misaka

app/lib/fhir_mapper/vaccination_record.rb

@@ -6,6 +6,8 @@ class VaccinationRecord
 
     MAVIS_SYSTEM_NAME =
       "http://manage-vaccinations-in-schools.nhs.uk/vaccination_records"
+    MAVIS_NATIONAL_REPORTING_SYSTEM_NAME =
+      "http://manage-vaccinations-in-schools.nhs.uk/national-reporting/vaccination-records"
 
     MILLILITER_SUB_STRINGS = %w[ml millilitre milliliter].freeze
 
@@ -123,7 +125,15 @@ def self.from_fhir_record(fhir_record, patient:)
     private
 
     def fhir_identifier
-      FHIR::Identifier.new(system: MAVIS_SYSTEM_NAME, value: uuid)
+      case source
+      when "bulk_upload"
+        FHIR::Identifier.new(
+          system: MAVIS_NATIONAL_REPORTING_SYSTEM_NAME,
+          value: uuid
+        )
+      else
+        FHIR::Identifier.new(system: MAVIS_SYSTEM_NAME, value: uuid)
+      end
     end
 
     def fhir_vaccination_procedure_extension

app/lib/nhs/immunisations_api.rb

@@ -262,11 +262,12 @@ def should_be_in_immunisations_api?(
       vaccination_record,
       ignore_nhs_number: false
     )
-      vaccination_record.kept? && vaccination_record.sourced_from_service? &&
+      vaccination_record.kept? &&
+        vaccination_record.correct_source_for_nhs_immunisations_api? &&
         vaccination_record.administered? &&
         Flipper.enabled?(:imms_api_sync_job, vaccination_record.programme) &&
         (ignore_nhs_number || vaccination_record.patient.nhs_number.present?) &&
-        vaccination_record.notify_parents &&
+        vaccination_record.notify_parents != false &&
         vaccination_record.patient.not_invalidated?
     end
 

app/models/concerns/vaccination_record_sync_to_nhs_immunisations_api_concern.rb

@@ -4,16 +4,24 @@ module VaccinationRecordSyncToNHSImmunisationsAPIConcern
   extend ActiveSupport::Concern
 
   included do
-    scope :syncable_to_nhs_immunisations_api,
-          -> { includes(:patient).sourced_from_service }
+    scope :with_correct_source_for_nhs_immunisations_api,
+          -> do
+            includes(:patient).then do
+              if Flipper.enabled?(:sync_national_reporting_to_imms_api)
+                it.sourced_from_service.or(it.sourced_from_bulk_upload)
+              else
+                it.sourced_from_service
+              end
+            end
+          end
 
     scope :sync_all_to_nhs_immunisations_api,
           -> do
             programmes =
               Programme.all.select { Flipper.enabled?(:imms_api_sync_job, it) }
 
             ids =
-              syncable_to_nhs_immunisations_api.for_programmes(
+              with_correct_source_for_nhs_immunisations_api.for_programmes(
                 programmes
               ).pluck(:id)
 
@@ -29,7 +37,13 @@ module VaccinationRecordSyncToNHSImmunisationsAPIConcern
     after_commit :queue_sync_to_nhs_immunisations_api
   end
 
-  def syncable_to_nhs_immunisations_api? = sourced_from_service?
+  def correct_source_for_nhs_immunisations_api?
+    sourced_from_service? ||
+      (
+        Flipper.enabled?(:sync_national_reporting_to_imms_api) &&
+          sourced_from_bulk_upload?
+      )
+  end
 
   def sync_status
     should_be_synced =
@@ -61,14 +75,14 @@ def changes_need_to_be_synced_to_nhs_immunisations_api?
 
   def touch_nhs_immunisations_api_sync_pending_at
     return unless Flipper.enabled?(:imms_api_sync_job, programme)
-    return unless syncable_to_nhs_immunisations_api?
+    return unless correct_source_for_nhs_immunisations_api?
 
     self.nhs_immunisations_api_sync_pending_at = Time.current
   end
 
   def queue_sync_to_nhs_immunisations_api
     return unless Flipper.enabled?(:imms_api_sync_job, programme)
-    return unless syncable_to_nhs_immunisations_api?
+    return unless correct_source_for_nhs_immunisations_api?
     return if nhs_immunisations_api_sync_pending_at.nil?
 
     if nhs_immunisations_api_synced_at &&

config/feature_flags.yml

@@ -43,6 +43,10 @@ reporting_api: Enables the Commissioner reporting component to authenticate to M
   Authorization Code Flow (https://datatracker.ietf.org/doc/html/rfc6749#section-4.1), and retrieve
   statistics from /api/reporting/
 
+sync_national_reporting_to_imms_api: |
+  Sync immunisations records uploaded as part of national reporting to the NHS
+  Immunisations API.
+
 testing_api: Basic API useful for automated testing.
 
 mmrv: Adds support for MMRV vaccinations

spec/features/import_vaccination_records_bulk_spec.rb

@@ -7,6 +7,7 @@
     given_mavis_logins_are_configured
     given_i_am_signed_in_as_a_bulk_upload_user
     given_a_patient_already_exists
+    and_sending_to_nhs_immunisations_api_is_enabled
 
     when_i_go_to_the_import_page
     then_i_should_see_the_upload_link
@@ -29,6 +30,7 @@
     and_the_patients_should_now_be_associated_with_the_team
     and_the_newly_created_patients_should_be_archived
     and_the_existing_patients_should_not_be_archived
+    and_the_vaccination_records_are_sent_to_the_imms_api
 
     when_i_click_on_a_vaccination_record
     then_i_should_see_the_vaccination_record
@@ -80,10 +82,14 @@ def given_a_patient_already_exists
     create(:vaccination_record, patient: @existing_patient, team: @team)
   end
 
-  def and_school_locations_exist
-    create(:school, urn: "110158")
-    create(:school, urn: "120026")
-    create(:school, urn: "144012")
+  def and_sending_to_nhs_immunisations_api_is_enabled
+    Flipper.enable(:imms_api_integration)
+    Flipper.enable(:imms_api_sync_job, Programme.flu)
+    Flipper.enable(:imms_api_sync_job, Programme.hpv)
+    Flipper.enable(:sync_national_reporting_to_imms_api)
+
+    @stubbed_post_request =
+      stub_immunisations_api_post(Random.uuid, Random.uuid)
   end
 
   def when_i_go_to_the_import_page
@@ -100,16 +106,6 @@ def when_i_click_on_the_upload_link
     click_on "Upload records"
   end
 
-  def when_i_click_on_the_imports_tab
-    click_on "Imports"
-  end
-
-  def and_i_choose_to_import_child_records
-    click_on "Upload records"
-    choose "Vaccination records"
-    click_on "Continue"
-  end
-
   def then_i_should_see_the_upload_page
     expect(page).to have_content("Upload vaccination records")
   end
@@ -189,6 +185,12 @@ def and_the_existing_patients_should_not_be_archived
     expect(@existing_patient.archived?(team: @team)).to be false
   end
 
+  def and_the_vaccination_records_are_sent_to_the_imms_api
+    SyncVaccinationRecordToNHSJob.drain
+
+    expect(@stubbed_post_request).to have_been_requested.times(2)
+  end
+
   def when_i_click_on_a_vaccination_record
     find(".nhsuk-details__summary", text: "2 imported records").click
     click_on "WEASLEY, Ron"

spec/lib/fhir_mapper/vaccination_record_spec.rb

@@ -88,6 +88,28 @@
 
       its(:value) { should eq vaccination_record.uuid }
       its(:system) { should eq mavis_system }
+
+      context "when the vaccination record is from national reporting" do
+        let(:national_reporting_test_ods_code) { "NR121" }
+        let(:vaccination_record) do
+          create(
+            :vaccination_record,
+            :sourced_from_bulk_upload,
+            uploaded_by: User.first,
+            performed_ods_code: :national_reporting_test_ods_code,
+            patient:,
+            programme:,
+            vaccine: programme.vaccines.first,
+            outcome: "administered"
+          )
+        end
+
+        let(:national_reporting_system) do
+          "http://manage-vaccinations-in-schools.nhs.uk/national-reporting/vaccination-records"
+        end
+
+        its(:system) { should eq national_reporting_system }
+      end
     end
 
     describe "vaccine code" do

spec/lib/nhs/immunisations_api_spec.rb

@@ -680,8 +680,12 @@
       it { should be false }
     end
 
-    context "when the vaccination record is not recorded in service" do
-      let(:session) { nil }
+    context "when the vaccination record doesn't have the correct source" do
+      before do
+        allow(vaccination_record).to receive(
+          :correct_source_for_nhs_immunisations_api?
+        ).and_return(false)
+      end
 
       it { should be false }
     end
@@ -740,6 +744,12 @@
       it { should be false }
     end
 
+    context "when notify_parents is not set" do
+      let(:notify_parents) { nil }
+
+      it { should be true }
+    end
+
     context "when the patient is invalidated" do
       before { patient.update(invalidated_at: Time.current) }
 

spec/models/concerns/vaccination_record_sync_to_nhs_immunisations_api_concern_spec.rb

@@ -29,7 +29,7 @@
     context "when the vaccination record isn't syncable" do
       before do
         allow(vaccination_record).to receive(
-          :syncable_to_nhs_immunisations_api?
+          :correct_source_for_nhs_immunisations_api?
         ).and_return(false)
       end
 
@@ -71,8 +71,10 @@
     end
   end
 
-  describe "syncable_to_nhs_immunisations_api scope" do
-    subject { VaccinationRecord.syncable_to_nhs_immunisations_api }
+  describe "with_correct_source_for_nhs_immunisations_api scope" do
+    subject { VaccinationRecord.with_correct_source_for_nhs_immunisations_api }
+
+    before { Flipper.enable(:sync_national_reporting_to_imms_api) }
 
     let!(:vaccination_record) do
       create(:vaccination_record, programme:, session:)
@@ -83,10 +85,46 @@
 
     it { should include(vaccination_record) }
     it { should_not include(vaccination_record_outside_of_session) }
+
+    context "when vaccination record was uploaded through national reporting portal" do
+      let!(:vaccination_record) do
+        create(:vaccination_record, :sourced_from_bulk_upload, programme:)
+      end
+
+      it { should include(vaccination_record) }
+
+      context "with the sync_national_reporting_to_imms_api feature flag disabled" do
+        before { Flipper.disable(:sync_national_reporting_to_imms_api) }
+
+        let!(:vaccination_record) do
+          create(:vaccination_record, :sourced_from_bulk_upload, programme:)
+        end
+
+        it { should_not include(vaccination_record) }
+      end
+    end
+
+    context "when vaccination record was part of a historical upload" do
+      let!(:vaccination_record) do
+        create(:vaccination_record, source: :historical_upload, programme:)
+      end
+
+      it { should_not include(vaccination_record) }
+    end
+
+    context "a vaccination record created because patient is already vaccinated" do
+      let!(:vaccination_record) do
+        create(:vaccination_record, source: :consent_refusal, programme:)
+      end
+
+      it { should_not include(vaccination_record) }
+    end
   end
 
-  describe "#syncable_to_nhs_immunisations_api?" do
-    subject { vaccination_record.syncable_to_nhs_immunisations_api? }
+  describe "#correct_source_to_nhs_immunisations_api?" do
+    subject { vaccination_record.correct_source_for_nhs_immunisations_api? }
+
+    before { Flipper.enable(:sync_national_reporting_to_imms_api) }
 
     context "when the vaccination record is eligible to sync" do
       it { should be true }
@@ -104,6 +142,38 @@
       it { should be false }
     end
 
+    context "a vaccination record uploaded through national reporting portal" do
+      let(:vaccination_record) do
+        build(
+          :vaccination_record,
+          :sourced_from_bulk_upload,
+          outcome:,
+          programme:
+        )
+      end
+
+      it { should be true }
+
+      context "with the sync_national_reporting_to_imms_api feature flag disabled" do
+        before { Flipper.disable(:sync_national_reporting_to_imms_api) }
+
+        it { should be false }
+      end
+    end
+
+    context "a vaccination record created because patient is already vaccinated" do
+      let(:vaccination_record) do
+        build(
+          :vaccination_record,
+          source: :consent_refusal,
+          outcome:,
+          programme:
+        )
+      end
+
+      it { should be false }
+    end
+
     context "a patient without an nhs number" do
       let(:patient) do
         create(:patient, nhs_number: nil, school: session.location)

spec/support/immunisations_api_helper.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
 
 module ImmunisationsAPIHelper
-  def stub_immunisations_api_post(uuid: Random.uuid)
+  def stub_immunisations_api_post(*uuids, uuid: Random.uuid)
+    uuids << uuid
+    responses =
+      uuids.map do |id|
+        {
+          status: 201,
+          body: nil,
+          headers: {
+            location:
+              "https://localhost:4000/immunisation-fhir-api/Immunization/#{id}"
+          }
+        }
+      end
+
     stub_request(
       :post,
       "https://sandbox.api.service.nhs.uk/immunisation-fhir-api/FHIR/R4/Immunization"
-    ).to_return(
-      status: 201,
-      body: nil,
-      headers: {
-        location:
-          "https://localhost:4000/immunisation-fhir-api/Immunization/#{uuid}"
-      }
-    )
+    ).to_return(responses)
   end
 
   def stub_immunisations_api_put(uuid: Random.uuid)