Separate-out consent fields into separate ReportableConsentEvent model. Split out ReportableEventMethods into a shared concern. Add Rake tasks for populating the reporting table

Author: Alistair Davidson

app/models/concerns/reportable_event_methods.rb

@@ -0,0 +1,24 @@
+module ReportableEventMethods
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :source, polymorphic: true
+    belongs_to :patient
+
+    before_validation :set_event_timestamp_date_part_attributes, :set_patient_year_group
+
+    protected
+
+    def set_patient_year_group
+      self.patient_year_group = self.patient&.year_group(now: self.event_timestamp&.to_date)
+    end
+
+    def set_event_timestamp_date_part_attributes
+      self.event_timestamp_day = event_timestamp&.day
+      self.event_timestamp_month = event_timestamp&.month
+      self.event_timestamp_year = event_timestamp&.year
+
+      self.event_timestamp_academic_year = event_timestamp.to_date.academic_year
+    end
+  end
+end

app/models/consent.rb

@@ -207,6 +207,29 @@ def notes_required?
       (response_refused? && !reason_for_refusal_personal_choice?)
   end
 
+  def create_or_update_reportable_consent_event
+    re =
+      ReportableConsentEvent.find_or_initialize_by(
+        event_timestamp: self.consent_form&.recorded_at || self.submitted_at,
+        event_type: ["consent", self.response].join("_"),
+        source_id: self.id,
+        source_type: self.class.name
+      )
+
+    re.copy_attributes_from_references(
+      patient: self.patient,
+      parent: self.parent,
+      parent_relationship: self.patient.parent_relationships.find_by(parent_id: self.parent_id),
+      consent: self,
+      programme: self.programme,
+      organisation: self.organisation 
+    )
+
+    re.save!
+    re
+  end
+
+
   class ConsentFormNotRecorded < StandardError
   end
 end

app/models/reportable_consent_event.rb

@@ -0,0 +1,11 @@
+class ReportableConsentEvent < ApplicationRecord
+  include DenormalizingConcern
+  include ReportableEventMethods
+
+  enum :event_type, {
+          consent_request_sent: "consent_request_sent",
+          consent_given: "consent_given",
+          consent_refused: "consent_refused",
+          consent_not_provided: 'consent_not_provided',
+      }, validate: true
+end

app/models/reportable_vaccination_event.rb

@@ -6,6 +6,7 @@
 #
 #  id                                          :bigint           not null, primary key
 #  event_timestamp                             :datetime
+#  event_timestamp_academic_year               :integer
 #  event_timestamp_day                         :integer
 #  event_timestamp_month                       :integer
 #  event_timestamp_year                        :integer
@@ -68,26 +69,12 @@
 #
 class ReportableVaccinationEvent < ApplicationRecord
   include DenormalizingConcern
-
-  belongs_to :source, polymorphic: true
-
+  include ReportableEventMethods
+  
   enum :event_type,
-       {
-         vaccination_not_well: "not_well",
-         vaccination_administered: "vaccination_administered",
-         consent_request_sent: "consent_request_sent",
-         consent_given: "consent_given",
-         consent_refused: "consent_refused"
-       },
-       validate: true
-
-  before_validation :set_event_timestamp_date_part_attributes
-
-  protected
-
-  def set_event_timestamp_date_part_attributes
-    self.event_timestamp_day = event_timestamp&.day
-    self.event_timestamp_month = event_timestamp&.month
-    self.event_timestamp_year = event_timestamp&.year
-  end
+        {
+          vaccination_not_well: "not_well",
+          vaccination_administered: "vaccination_administered",
+        },
+        validate: true
 end

app/models/vaccination_record.rb

@@ -196,7 +196,7 @@ def create_or_update_reportable_vaccination_event
       organisation: self.team&.organisation,
       programme: self.programme
     )
-    re.patient_year_group = self.patient&.year_group(now: self.performed_at&.to_date)
+
     re.save!
     re
   end

db/migrate/20250624135538_add_reportable_events.rb

@@ -8,7 +8,8 @@ def change
       t.integer :event_timestamp_year
       t.integer :event_timestamp_month
       t.integer :event_timestamp_day
-
+      t.integer :event_timestamp_academic_year
+      
       t.references :source, polymorphic: true
 
       t.bigint :patient_id

db/migrate/20250627081633_add_reportable_consent_events.rb

@@ -0,0 +1,74 @@
+class AddReportableConsentEvents < ActiveRecord::Migration[8.0]
+  def change
+    create_table :reportable_consent_events do |t|
+      t.string :event_type
+      t.datetime :event_timestamp
+      t.integer :event_timestamp_year
+      t.integer :event_timestamp_month
+      t.integer :event_timestamp_day
+      t.integer :event_timestamp_academic_year
+
+      t.references :source, polymorphic: true
+
+      t.bigint :patient_id
+      t.date :patient_date_of_birth
+      t.string :patient_nhs_number
+
+      t.string :patient_address_town
+      t.string :patient_address_postcode
+      t.string :patient_gender_code
+      t.boolean :patient_home_educated
+      t.date :patient_date_of_death
+      t.integer :patient_birth_academic_year
+      t.integer :patient_year_group
+
+      t.integer :consent_response
+      t.integer :consent_reason_for_refusal
+      t.text :consent_notes
+      t.integer :consent_route
+      t.jsonb :consent_health_answers
+      t.bigint :consent_recorded_by_user_id
+      t.bigint :consent_parent_id
+      t.bigint :consent_organisation_id
+      t.datetime :consent_withdrawn_at
+      t.datetime :consent_invalidated_at
+      t.boolean :consent_notify_parents
+      t.datetime :consent_submitted_at
+      t.integer :consent_vaccine_methods, array: true
+
+      t.string :parent_full_name
+      t.string :parent_email
+      t.string :parent_phone
+      t.text :parent_contact_method_other_details
+      t.datetime :parent_created_at
+      t.datetime :parent_updated_at
+      t.string :parent_contact_method_type
+      t.boolean :parent_phone_receive_updates
+
+      t.string :parent_relationship_type
+      t.string :parent_relationship_other_name
+
+      t.string :consent_recorded_by_user_email
+      t.string :consent_recorded_by_user_given_name
+      t.string :consent_recorded_by_user_family_name
+      
+      t.bigint :vaccine_id
+      t.text :vaccine_brand
+      t.integer :vaccine_method
+      t.text :vaccine_manufacturer
+      t.decimal :vaccine_dose_volume_ml
+      t.string :vaccine_snomed_product_code
+      t.string :vaccine_snomed_product_term
+      t.text :vaccine_nivs_name
+      t.boolean :vaccine_discontinued
+      t.bigint :vaccine_programme_id
+      t.boolean :vaccine_full_dose
+
+      t.bigint :programme_id
+      t.string :programme_type
+
+      t.timestamps
+    end
+
+  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.0].define(version: 2025_06_26_162928) do
+ActiveRecord::Schema[8.0].define(version: 2025_06_27_081633) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -659,12 +659,76 @@
     t.index ["type"], name: "index_programmes_on_type", unique: true
   end
 
+  create_table "reportable_consent_events", force: :cascade do |t|
+    t.string "event_type"
+    t.datetime "event_timestamp"
+    t.integer "event_timestamp_year"
+    t.integer "event_timestamp_month"
+    t.integer "event_timestamp_day"
+    t.integer "event_timestamp_academic_year"
+    t.string "source_type"
+    t.bigint "source_id"
+    t.bigint "patient_id"
+    t.date "patient_date_of_birth"
+    t.string "patient_nhs_number"
+    t.string "patient_address_town"
+    t.string "patient_address_postcode"
+    t.string "patient_gender_code"
+    t.boolean "patient_home_educated"
+    t.date "patient_date_of_death"
+    t.integer "patient_birth_academic_year"
+    t.integer "patient_year_group"
+    t.integer "consent_response"
+    t.integer "consent_reason_for_refusal"
+    t.text "consent_notes"
+    t.integer "consent_route"
+    t.jsonb "consent_health_answers"
+    t.bigint "consent_recorded_by_user_id"
+    t.bigint "consent_parent_id"
+    t.bigint "consent_organisation_id"
+    t.datetime "consent_withdrawn_at"
+    t.datetime "consent_invalidated_at"
+    t.boolean "consent_notify_parents"
+    t.datetime "consent_submitted_at"
+    t.integer "consent_vaccine_methods", array: true
+    t.string "parent_full_name"
+    t.string "parent_email"
+    t.string "parent_phone"
+    t.text "parent_contact_method_other_details"
+    t.datetime "parent_created_at"
+    t.datetime "parent_updated_at"
+    t.string "parent_contact_method_type"
+    t.boolean "parent_phone_receive_updates"
+    t.string "parent_relationship_type"
+    t.string "parent_relationship_other_name"
+    t.string "consent_recorded_by_user_email"
+    t.string "consent_recorded_by_user_given_name"
+    t.string "consent_recorded_by_user_family_name"
+    t.bigint "vaccine_id"
+    t.text "vaccine_brand"
+    t.integer "vaccine_method"
+    t.text "vaccine_manufacturer"
+    t.decimal "vaccine_dose_volume_ml"
+    t.string "vaccine_snomed_product_code"
+    t.string "vaccine_snomed_product_term"
+    t.text "vaccine_nivs_name"
+    t.boolean "vaccine_discontinued"
+    t.bigint "vaccine_programme_id"
+    t.boolean "vaccine_full_dose"
+    t.bigint "programme_id"
+    t.string "programme_type"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["source_type", "source_id"], name: "index_reportable_consent_events_on_source"
+  end
+
   create_table "reportable_vaccination_events", force: :cascade do |t|
     t.string "event_type"
     t.datetime "event_timestamp"
     t.integer "event_timestamp_year"
     t.integer "event_timestamp_month"
     t.integer "event_timestamp_day"
+    t.integer "event_timestamp_academic_year"
     t.string "source_type"
     t.bigint "source_id"
     t.bigint "patient_id"

lib/tasks/events.rake

@@ -1,18 +1,39 @@
 # frozen_string_literal: true
 
 namespace :events do
-  desc "Clear all reportable events"
-  task clear: :environment do
-    ReportableVaccinationEvent.delete_all
+  namespace :vaccinations do
+    desc "Clear all reportable vaccination events"
+    task clear: :environment do
+      ReportableVaccinationEvent.delete_all
+    end
+
+    desc "Write reportable vaccination events for all VaccinationRecords"
+    task write_all: :environment do
+      puts "#{VaccinationRecord.count} vaccination records"
+
+      VaccinationRecord.all.find_each do |vaccination|
+        vaccination.create_or_update_reportable_vaccination_event
+      end
+
+      puts "#{ReportableVaccinationEvent.count} reportable events"
+    end
   end
 
-  desc "Write all VaccinationRecord events"
-  task write_vaccination_records: :environment do
-    puts "#{VaccinationRecord.count} vaccination records"
-    puts "#{ReportableEvent.count} reportable events"
+  namespace :consents do
+    desc "Clear all reportable consent events"
+    task clear: :environment do
+      ReportableConsentEvent.delete_all
+    end
 
-    VaccinationRecord.all.find_each do |vaccination|
-      vaccination.create_or_update_reportable_vaccination_event!
+    desc "Write reportable consent events for all Consent records"
+    task write_all: :environment do
+      puts "#{Consent.count} consent records"
+      
+      Consent.all.find_each do |consent|
+        consent.create_or_update_reportable_consent_event
+      end
+      puts "#{ReportableConsentEvent.count} reportable events"
     end
   end
+  
 end

spec/models/reportable_vaccination_event_spec.rb

@@ -6,6 +6,7 @@
 #
 #  id                                          :bigint           not null, primary key
 #  event_timestamp                             :datetime
+#  event_timestamp_academic_year               :integer
 #  event_timestamp_day                         :integer
 #  event_timestamp_month                       :integer
 #  event_timestamp_year                        :integer