Add locations to vaccination records

Currently the location of a vaccination record is determined from the
session it was recorded in. In most cases, this will be the same,
however there are scenarios where this is not the case:

- If the session is for the generic clinic, the location needs to be set
  to one of the community clinics.
- If a nurse is marking a patient as already having had the vaccine,
  this happens in a session, but the vaccination would have occurred
  elsewhere.

The first case is already handled by the `location_name` column which is
a free-text field and can contain anything. This works, but is
unstructured, ideally we'd like to move to a place where we can link
these records with the locations in the database for the community
clinic. This commit gets us closer to that point.

The second case is not handled currently. Instead, when recording a
patient as having already had the vaccine, the location of the
vaccination ends up being the session that the nurse happened to use to
mark the patient as vaccinated already. In some cases this might be
correct, but in most it won't be. This commit allows us to fix the
second case, which will be done in a followup commit to this one.

Author: thomasleese

app/controllers/patient_sessions/programmes_controller.rb

@@ -20,6 +20,7 @@ def record_already_vaccinated
     draft_vaccination_record.reset!
     draft_vaccination_record.update!(
       first_active_wizard_step: :confirm,
+      location: @session.location,
       location_name: @session.clinic? ? "Unknown" : nil,
       outcome: :already_had,
       patient: @patient,

app/forms/vaccinate_form.rb

@@ -88,6 +88,8 @@ def save(draft_vaccination_record:)
       identity_check_confirmed_by_other_relationship
     draft_vaccination_record.identity_check_confirmed_by_patient =
       identity_check_confirmed_by_patient
+    draft_vaccination_record.location_id =
+      session.location_id unless session.generic_clinic?
     draft_vaccination_record.patient_id = patient_session.patient_id
     draft_vaccination_record.performed_at = Time.current
     draft_vaccination_record.performed_by_user = current_user
@@ -100,7 +102,7 @@ def save(draft_vaccination_record:)
 
   private
 
-  delegate :organisation, to: :patient_session
+  delegate :organisation, :session, to: :patient_session
 
   def administered? = vaccine_method != "none"
 

app/lib/reports/export_formatters.rb

@@ -14,15 +14,15 @@ def school_urn(location:, patient:)
   end
 
   def school_name(location:, patient:)
-    location.school? ? location.name : patient.school&.name || ""
+    location&.school? ? location.name : patient.school&.name || ""
   end
 
   def care_setting(location:)
-    location.school? ? "1" : "2"
+    location&.school? ? "1" : "2"
   end
 
   def clinic_name(location:, vaccination_record:)
-    location.school? ? "" : vaccination_record.location_name
+    location&.school? ? "" : vaccination_record.location_name
   end
 
   def consent_status(patient:, programme:, academic_year:)

app/lib/reports/programme_vaccinations_exporter.rb

@@ -93,6 +93,7 @@ def vaccination_records
           :batch,
           :location,
           :performed_by_user,
+          :session,
           :vaccine,
           patient: %i[consent_statuses gp_practice school]
         )

app/lib/reports/systm_one_exporter.rb

@@ -150,7 +150,7 @@ def row(vaccination_record:)
 
   # TODO: Needs support for community and generic clinics.
   def practice_code(vaccination_record)
-    location = vaccination_record.session.location
+    location = vaccination_record.location
 
     location.school? ? location.urn : location.ods_code
   end

app/models/draft_vaccination_record.rb

@@ -16,6 +16,7 @@ class DraftVaccinationRecord
   attribute :identity_check_confirmed_by_other_name, :string
   attribute :identity_check_confirmed_by_other_relationship, :string
   attribute :identity_check_confirmed_by_patient, :boolean
+  attribute :location_id, :integer
   attribute :location_name, :string
   attribute :notes, :string
   attribute :outcome, :string
@@ -49,7 +50,7 @@ def wizard_steps
       (:delivery if administered?),
       (:dose if administered? && can_be_half_dose?),
       (:batch if administered?),
-      (:location if location&.generic_clinic?),
+      (:location if session&.generic_clinic?),
       :confirm
     ].compact
   end
@@ -141,6 +142,15 @@ def batch=(value)
     self.batch_id = value.id
   end
 
+  def location
+    return nil if location_id.nil?
+    Location.find(location_id)
+  end
+
+  def location=(value)
+    self.location_id = value&.id
+  end
+
   def patient
     return nil if patient_id.nil?
 
@@ -151,8 +161,6 @@ def patient=(value)
     self.patient_id = value.id
   end
 
-  delegate :location, to: :session, allow_nil: true
-
   def performed_by_user
     return nil if performed_by_user_id.nil?
 
@@ -266,6 +274,7 @@ def writable_attribute_names
       full_dose
       protocol
       identity_check
+      location_id
       location_name
       notes
       outcome

app/models/immunisation_import_row.rb

@@ -98,6 +98,7 @@ def to_vaccination_record
     attributes = {
       dose_sequence: dose_sequence_value,
       full_dose: true,
+      location:,
       location_name:,
       outcome:,
       patient_id: patient.id,
@@ -225,8 +226,12 @@ def vaccine_name = @data[:vaccine_given]
 
   delegate :organisation, to: :team
 
+  def location
+    session&.location unless session&.generic_clinic?
+  end
+
   def location_name
-    return unless session.nil? || session.location.generic_clinic?
+    return unless location.nil?
 
     if is_school_setting? || (is_unknown_setting? && clinic_name.blank?)
       school&.name || school_name&.to_s || "Unknown"

app/models/session.rb

@@ -166,7 +166,7 @@ class Session < ApplicationRecord
 
   before_create :set_slug
 
-  delegate :clinic?, :school?, to: :location
+  delegate :clinic?, :generic_clinic?, :school?, to: :location
 
   def to_param
     slug

app/models/vaccination_record.rb

@@ -28,6 +28,7 @@
 #  created_at                            :datetime         not null
 #  updated_at                            :datetime         not null
 #  batch_id                              :bigint
+#  location_id                           :bigint
 #  nhs_immunisations_api_id              :string
 #  patient_id                            :bigint
 #  performed_by_user_id                  :bigint
@@ -39,6 +40,7 @@
 #
 #  index_vaccination_records_on_batch_id                  (batch_id)
 #  index_vaccination_records_on_discarded_at              (discarded_at)
+#  index_vaccination_records_on_location_id               (location_id)
 #  index_vaccination_records_on_nhs_immunisations_api_id  (nhs_immunisations_api_id) UNIQUE
 #  index_vaccination_records_on_patient_id                (patient_id)
 #  index_vaccination_records_on_performed_by_user_id      (performed_by_user_id)
@@ -90,14 +92,14 @@ class VaccinationRecord < ApplicationRecord
 
   has_and_belongs_to_many :immunisation_imports
 
+  belongs_to :location, optional: true
   belongs_to :patient
   belongs_to :session, optional: true
 
   has_one :identity_check, autosave: true, dependent: :destroy
-  has_one :location, through: :session
   has_one :organisation, through: :session
-  has_one :team, through: :session
   has_one :subteam, through: :session
+  has_one :team, through: :session
 
   scope :for_academic_year,
         ->(academic_year) do
@@ -214,9 +216,7 @@ def snomed_procedure_code = vaccine&.snomed_procedure_code(dose_sequence:)
 
   private
 
-  def requires_location_name?
-    session.nil? || location&.generic_clinic?
-  end
+  def requires_location_name? = location.nil?
 
   delegate :maximum_dose_sequence, to: :programme
 

db/migrate/20250514170839_add_location_to_vaccination_records.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class AddLocationToVaccinationRecords < ActiveRecord::Migration[8.0]
+  def change
+    add_reference :vaccination_records, :location
+
+    reversible do |dir|
+      dir.up do
+        VaccinationRecord
+          .where.not(session_id: nil)
+          .eager_load(:session)
+          .find_each { it.update_column(:location_id, it.session.location_id) }
+      end
+    end
+  end
+end