Merge pull request #5535 from nhsuk/add-disease-types-to-vaccination-records

Add disease types to vaccination records

Author: thomasleese

app/jobs/patients_refused_consent_already_vaccinated_job.rb

@@ -56,6 +56,8 @@ def record_already_vaccinated!(patient, programme:, consents:)
     performed_at = consents.map(&:submitted_at).min
 
     VaccinationRecord.create!(
+      # TODO: Change this to `consent.disease_types` when available.
+      disease_types: programme.disease_types,
       location_name: "Unknown",
       notes:,
       outcome: "already_had",

app/lib/fhir_mapper/vaccination_record.rb

@@ -105,12 +105,14 @@ def self.from_fhir_record(fhir_record, patient:)
       attrs[:vaccine] = Vaccine.from_fhir_record(fhir_record)
 
       if attrs[:vaccine]
+        attrs[:disease_types] = attrs[:vaccine].disease_types
         attrs[:batch] = batch_from_fhir(fhir_record, vaccine: attrs[:vaccine])
         attrs[:full_dose] = full_dose_from_fhir(
           fhir_record,
           vaccine: attrs[:vaccine]
         )
       else
+        attrs[:disease_types] = attrs[:programme].disease_types
         attrs[:notes] = vaccine_batch_notes_from_fhir(fhir_record)
         attrs[:full_dose] = true
       end

app/models/draft_vaccination_record.rb

@@ -10,6 +10,7 @@ class DraftVaccinationRecord
   attribute :batch_id, :integer
   attribute :delivery_method, :string
   attribute :delivery_site, :string
+  attribute :disease_types, array: true
   attribute :dose_sequence, :integer
   attribute :first_active_wizard_step, :string
   attribute :full_dose, :boolean
@@ -25,9 +26,9 @@ class DraftVaccinationRecord
   attribute :performed_by_family_name, :string
   attribute :performed_by_given_name, :string
   attribute :performed_by_user_id, :integer
-  attribute :protocol, :string
   attribute :performed_ods_code, :string
   attribute :programme_type, :string
+  attribute :protocol, :string
   attribute :session_id, :integer
   attribute :supplied_by_user_id, :integer
 
@@ -299,6 +300,7 @@ def writable_attribute_names
       batch_id
       delivery_method
       delivery_site
+      disease_types
       dose_sequence
       full_dose
       identity_check
@@ -336,6 +338,8 @@ def reset_unused_attributes
       self.identity_check_confirmed_by_other_name = ""
       self.identity_check_confirmed_by_other_relationship = ""
     end
+
+    self.disease_types = vaccine&.disease_types || programme.disease_types
   end
 
   def academic_year = session&.academic_year

app/models/immunisation_import_row.rb

@@ -126,6 +126,7 @@ def to_vaccination_record
       end
 
     attributes = {
+      disease_types:,
       dose_sequence: dose_sequence_value,
       full_dose: true,
       outcome:,
@@ -138,8 +139,8 @@ def to_vaccination_record
       session:,
       supplied_by:
     }
-    attributes.merge!(location:, location_name:) unless imms_api_record?
 
+    attributes.merge!(location:, location_name:) unless imms_api_record?
     attributes.merge!(notify_parents: true) if session
 
     if performed_by_user.nil? &&
@@ -498,6 +499,8 @@ def delivery_method_value
     end
   end
 
+  def disease_types = vaccine&.disease_types || programme.disease_types
+
   def dose_sequence_value
     value =
       parsed_vaccination_description_string&.dig(:dose_sequence) ||

app/models/vaccination_record.rb

@@ -9,6 +9,7 @@
 #  delivery_method                         :integer
 #  delivery_site                           :integer
 #  discarded_at                            :datetime
+#  disease_types                           :enum             is an Array
 #  dose_sequence                           :integer
 #  full_dose                               :boolean
 #  local_patient_id_uri                    :string

db/migrate/20251215114448_add_disease_types_to_vaccination_records.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddDiseaseTypesToVaccinationRecords < ActiveRecord::Migration[8.1]
+  def change
+    add_column :vaccination_records,
+               :disease_types,
+               :enum,
+               enum_type: :disease_type,
+               array: true
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.1].define(version: 2025_12_15_103351) do
+ActiveRecord::Schema[8.1].define(version: 2025_12_15_114448) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -932,6 +932,7 @@
     t.integer "delivery_method"
     t.integer "delivery_site"
     t.datetime "discarded_at"
+    t.enum "disease_types", array: true, enum_type: "disease_type"
     t.integer "dose_sequence"
     t.boolean "full_dose"
     t.string "local_patient_id"

lib/tasks/data_migration.rake

@@ -5,4 +5,16 @@ namespace :data_migration do
   task create_clinic_notifications: :environment do
     DataMigration::CreateClinicNotifications.call
   end
+
+  desc "Set disease types on vaccination records."
+  task set_disease_types: :environment do
+    VaccinationRecord
+      .includes(:vaccine)
+      .find_each do |vaccination_record|
+        disease_types =
+          vaccination_record.vaccine&.disease_types ||
+            vaccination_record.programme.disease_types
+        vaccination_record.update_columns(disease_types:)
+      end
+  end
 end

spec/factories/vaccination_records.rb

@@ -9,6 +9,7 @@
 #  delivery_method                         :integer
 #  delivery_site                           :integer
 #  discarded_at                            :datetime
+#  disease_types                           :enum             is an Array
 #  dose_sequence                           :integer
 #  full_dose                               :boolean
 #  local_patient_id_uri                    :string
@@ -95,6 +96,7 @@
     delivery_method { "intramuscular" }
 
     vaccine { programme.vaccines.active.sample if session }
+    disease_types { vaccine&.disease_types || programme.disease_types }
 
     batch do
       if vaccine

spec/features/hpv_vaccination_administered_spec.rb

@@ -46,6 +46,7 @@
 
     when_i_confirm_the_details
     then_i_see_a_success_message
+    and_the_disease_types_are_set_on_the_record
     and_i_can_no_longer_vaccinate_the_patient
     and_i_no_longer_see_the_patient_in_the_record_tab
     and_i_no_longer_see_the_patient_in_the_consent_tab
@@ -238,6 +239,12 @@ def then_i_see_a_success_message
     expect(page).to have_content("Vaccination outcome recorded for HPV")
   end
 
+  def and_the_disease_types_are_set_on_the_record
+    expect(VaccinationRecord.last.disease_types).to contain_exactly(
+      "human_papillomavirus"
+    )
+  end
+
   def and_i_can_no_longer_vaccinate_the_patient
     expect(page).not_to have_content("You still need to record an outcome")
     expect(page).not_to have_content("ready for their HPV vaccination?")