Merge pull request #6484 from NHSDigital/split-vax-reporting

Split `vaccinations_given` by school and community

Author: mikejamesthompson

app/controllers/api/reporting/totals_controller.rb

@@ -25,6 +25,13 @@ class API::Reporting::TotalsController < API::Reporting::BaseController
     patient_school_name: "School Name"
   }.freeze
 
+  SCHOOL_LOCATION_TYPES = %w[gias_school generic_school].freeze
+  COMMUNITY_LOCATION_TYPES = %w[
+    generic_clinic
+    community_clinic
+    gp_practice
+  ].freeze
+
   METRIC_HEADERS = {
     cohort: "Cohort",
     no_consent: "No Consent",
@@ -179,7 +186,7 @@ def apply_year_group_filter
   def team_vaccination_records_scope
     VaccinationRecord
       .where(discarded_at: nil, outcome: :administered)
-      .joins(session: :team_location)
+      .joins(session: { team_location: :location })
       .where(
         team_locations: {
           team_id: @team&.id || current_user.team_ids,
@@ -205,24 +212,50 @@ def team_vaccination_records_scope
   end
 
   def team_vaccinations_given_count
-    team_vaccination_records_scope.count
+    pivot_location_counts(
+      team_vaccination_records_scope.group("locations.type").count
+    )
   end
 
   def team_monthly_vaccinations_given
-    counts =
-      team_vaccination_records_scope
-        .group(
-          Arel.sql(
-            "EXTRACT(YEAR FROM vaccination_records.performed_at_date)::integer"
-          ),
-          Arel.sql(
-            "EXTRACT(MONTH FROM vaccination_records.performed_at_date)::integer"
-          )
-        )
-        .count
-        .map do |(year, month), count|
-          { year:, month: Date::MONTHNAMES[month], count: }
-        end
-    counts.sort_by! { [it[:year], Date::MONTHNAMES.index(it[:month])] }
+    counts_by_key =
+      team_vaccination_records_scope.group(
+        Arel.sql(
+          "EXTRACT(YEAR FROM vaccination_records.performed_at_date)::integer"
+        ),
+        Arel.sql(
+          "EXTRACT(MONTH FROM vaccination_records.performed_at_date)::integer"
+        ),
+        "locations.type"
+      ).count
+
+    grouped = Hash.new { |h, k| h[k] = { school_count: 0, community_count: 0 } }
+
+    counts_by_key.each do |(year, month, loc_type), count|
+      key = [year, month]
+      if SCHOOL_LOCATION_TYPES.include?(loc_type)
+        grouped[key][:school_count] += count
+      elsif COMMUNITY_LOCATION_TYPES.include?(loc_type)
+        grouped[key][:community_count] += count
+      end
+    end
+
+    result =
+      grouped.map do |(year, month), counts|
+        { year:, month: Date::MONTHNAMES[month], **counts }
+      end
+    result.sort_by! { [it[:year], Date::MONTHNAMES.index(it[:month])] }
+  end
+
+  def pivot_location_counts(counts_by_type)
+    school_count =
+      counts_by_type.sum do |type, count|
+        SCHOOL_LOCATION_TYPES.include?(type) ? count : 0
+      end
+    community_count =
+      counts_by_type.sum do |type, count|
+        COMMUNITY_LOCATION_TYPES.include?(type) ? count : 0
+      end
+    { school_count:, community_count: }
   end
 end

spec/controllers/api/reporting/totals_controller_spec.rb

@@ -65,7 +65,9 @@
       expect(not_vaccinated).to eq(1) # patient3
       expect(vaccinated + not_vaccinated).to eq(cohort)
 
-      expect(parsed_response["vaccinations_given"]).to eq(2) # 2 administered records
+      expect(parsed_response["vaccinations_given"]).to eq(
+        { "school_count" => 2, "community_count" => 0 }
+      )
       expect(parsed_response["monthly_vaccinations_given"]).to be_an(Array)
     end
 
@@ -510,15 +512,18 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(1)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 1, "community_count" => 0 }
+      )
 
       monthly =
         monthly_vaccinations_given.find do
           it["year"] == Time.current.year &&
             it["month"] == Date::MONTHNAMES[Time.current.month]
         end
       expect(monthly).to be_present
-      expect(monthly["count"]).to eq(1)
+      expect(monthly["school_count"]).to eq(1)
+      expect(monthly["community_count"]).to eq(0)
     end
 
     it "counts vaccination in correct month when performed during BST" do
@@ -540,7 +545,8 @@ def refresh_and_get_totals(programme_type: "hpv")
         end
       expect(monthly).to be_present,
       "Expected vaccination to be counted in September, not August"
-      expect(monthly["count"]).to eq(1)
+      expect(monthly["school_count"]).to eq(1)
+      expect(monthly["community_count"]).to eq(0)
     end
 
     it "child archived after being vaccinated by SAIS" do
@@ -628,7 +634,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -649,7 +657,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -673,7 +683,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(vaccinated).to eq(0)
       expect(not_vaccinated).to eq(1)
 
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -693,7 +705,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -717,7 +731,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -749,7 +765,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -774,7 +792,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       # flu is seasonal so vaccinations from a previous year don't count
       expect(vaccinated).to eq(0)
       expect(not_vaccinated).to eq(1)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -794,7 +814,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(0)
       expect(not_vaccinated).to eq(1)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -815,7 +837,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(0)
       expect(not_vaccinated).to eq(1)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -836,7 +860,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -869,7 +895,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -893,7 +921,9 @@ def refresh_and_get_totals(programme_type: "hpv")
       expect(cohort).to eq(1)
       expect(vaccinated).to eq(1)
       expect(not_vaccinated).to eq(0)
-      expect(vaccinations_given).to eq(0)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 0, "community_count" => 0 }
+      )
       expect(monthly_vaccinations_given).to be_empty
     end
 
@@ -928,14 +958,68 @@ def refresh_and_get_totals(programme_type: "hpv")
 
       # Child moved out, but vaccination was given by this team
       # so it should be counted as given
-      expect(vaccinations_given).to eq(1)
+      expect(vaccinations_given).to eq(
+        { "school_count" => 1, "community_count" => 0 }
+      )
+      monthly =
+        monthly_vaccinations_given.find do
+          it["year"] == Time.current.year &&
+            it["month"] == Date::MONTHNAMES[Time.current.month]
+        end
+      expect(monthly).to be_present
+      expect(monthly["school_count"]).to eq(1)
+      expect(monthly["community_count"]).to eq(0)
+    end
+
+    it "splits vaccinations given by school and community location" do
+      school_patient = create(:patient, session: hpv_session)
+      create(
+        :vaccination_record,
+        patient: school_patient,
+        programme: hpv_programme,
+        session: hpv_session,
+        outcome: "administered",
+        performed_at: Time.current
+      )
+
+      community_clinic =
+        create(
+          :community_clinic,
+          team:,
+          programmes: [hpv_programme],
+          academic_year: AcademicYear.current
+        )
+      community_session =
+        create(
+          :session,
+          team:,
+          location: community_clinic,
+          programmes: [hpv_programme]
+        )
+      community_patient = create(:patient, session: community_session)
+      create(
+        :vaccination_record,
+        patient: community_patient,
+        programme: hpv_programme,
+        session: community_session,
+        outcome: "administered",
+        performed_at: Time.current
+      )
+
+      refresh_and_get_totals
+
+      expect(vaccinations_given).to eq(
+        { "school_count" => 1, "community_count" => 1 }
+      )
+
       monthly =
         monthly_vaccinations_given.find do
           it["year"] == Time.current.year &&
             it["month"] == Date::MONTHNAMES[Time.current.month]
         end
       expect(monthly).to be_present
-      expect(monthly["count"]).to eq(1)
+      expect(monthly["school_count"]).to eq(1)
+      expect(monthly["community_count"]).to eq(1)
     end
 
     it "counts HPV cohort correctly across years 8 to 11" do