Generate consent status from submitted at time (#3563)

This changes how we determine the most recent consent response from the
`created_at` to the `submitted_at`. In most cases these values will be
the same, but it's possible for a consent to be matched with a patient
manually which can occur some period of time after the consent was
submitted.

In particular, it's possible to manually match multiple consents in a
different order to when they were submitted, which can lead to bugs
where the patient is given the wrong consent status.

This has been implemented by storing a `submitted_at` column on consent
responses, which has been done to ensure we don't hit performance issues
when filtering or ordering consents where we need to fetch the related
consent form.

This is a version of
#3558 which
will be merged in to `main` to make sure it's in the 2.2.2 release.

[Jira Issue](https://nhsd-jira.digital.nhs.uk/browse/MAV-1196)

Author: thomasleese

app/components/app_activity_log_component.rb

@@ -99,7 +99,7 @@ def consent_events
         {
           title:
             "Consent #{original_response} by #{consent.name} (#{consent.who_responded})",
-          at: consent.created_at,
+          at: consent.submitted_at,
           by: consent.recorded_by,
           programmes: programmes_for(consent)
         }

app/lib/consent_grouper.rb

@@ -15,15 +15,15 @@ def call
         .reject(&:invalidated?)
         .select(&:response_provided?)
         .group_by(&:name)
-        .map { it.second.max_by(&:created_at) }
+        .map { it.second.max_by(&:submitted_at) }
     else
       consents
         .where(programme_id:)
         .not_invalidated
         .response_provided
         .includes(:parent)
         .group_by(&:name)
-        .map { it.second.max_by(&:created_at) }
+        .map { it.second.max_by(&:submitted_at) }
     end
   end
 

app/models/consent.rb

@@ -12,6 +12,7 @@
 #  reason_for_refusal  :integer
 #  response            :integer          not null
 #  route               :integer          not null
+#  submitted_at        :datetime         not null
 #  withdrawn_at        :datetime
 #  created_at          :datetime         not null
 #  updated_at          :datetime         not null
@@ -121,7 +122,7 @@ def can_invalidate?
   end
 
   def responded_at
-    invalidated_at || withdrawn_at || consent_form&.recorded_at || created_at
+    invalidated_at || withdrawn_at || submitted_at
   end
 
   def triage_needed?
@@ -149,6 +150,8 @@ def reasons_triage_needed
   end
 
   def self.from_consent_form!(consent_form, patient:, current_user:)
+    raise ConsentFormNotRecorded unless consent_form.recorded?
+
     ActiveRecord::Base.transaction do
       parent =
         consent_form.find_or_create_parent_with_relationship_to!(patient:)
@@ -164,7 +167,8 @@ def self.from_consent_form!(consent_form, patient:, current_user:)
             response: "given",
             route: "website",
             health_answers: consent_form.health_answers,
-            recorded_by: current_user
+            recorded_by: current_user,
+            submitted_at: consent_form.recorded_at
           )
         end
 
@@ -180,7 +184,8 @@ def self.from_consent_form!(consent_form, patient:, current_user:)
             response: "refused",
             route: "website",
             health_answers: consent_form.health_answers,
-            recorded_by: current_user
+            recorded_by: current_user,
+            submitted_at: consent_form.recorded_at
           )
         end
 
@@ -194,4 +199,7 @@ def notes_required?
     withdrawn? || invalidated? ||
       (response_refused? && !reason_for_refusal_personal_choice?)
   end
+
+  class ConsentFormNotRecorded < StandardError
+  end
 end

app/models/consent_form.rb

@@ -278,6 +278,10 @@ def wizard_steps
     ].compact
   end
 
+  def recorded?
+    recorded_at != nil
+  end
+
   def each_health_answer
     return if health_answers.empty?
     return to_enum(:each_health_answer) unless block_given?

app/models/draft_consent.rb

@@ -250,6 +250,7 @@ def write_to!(consent, triage:)
     super(consent)
 
     consent.parent = parent
+    consent.submitted_at ||= Time.current
 
     if triage_allowed? && response_given?
       triage.notes = triage_notes || ""

db/migrate/20250515173205_add_submitted_at_to_consents.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class AddSubmittedAtToConsents < ActiveRecord::Migration[8.0]
+  def up
+    add_column :consents, :submitted_at, :datetime
+
+    Consent
+      .includes(:consent_form)
+      .find_each do |consent|
+        submitted_at = consent.consent_form&.recorded_at || consent.created_at
+        consent.update_column(:submitted_at, submitted_at)
+      end
+
+    change_column_null :consents, :submitted_at, false
+  end
+
+  def down
+    remove_column :consents, :submitted_at
+  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_04_29_140846) do
+ActiveRecord::Schema[8.0].define(version: 2025_05_15_173205) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "pg_catalog.plpgsql"
   enable_extension "pg_trgm"
@@ -237,6 +237,7 @@
     t.datetime "withdrawn_at"
     t.datetime "invalidated_at"
     t.boolean "notify_parents"
+    t.datetime "submitted_at", null: false
     t.index ["organisation_id"], name: "index_consents_on_organisation_id"
     t.index ["parent_id"], name: "index_consents_on_parent_id"
     t.index ["patient_id"], name: "index_consents_on_patient_id"

spec/components/app_activity_log_component_spec.rb

@@ -63,7 +63,7 @@
         programme: programmes.first,
         patient:,
         parent: mum,
-        created_at: Time.zone.parse("2024-05-30 12:00"),
+        submitted_at: Time.zone.parse("2024-05-30 12:00"),
         recorded_by: user
       )
       create(
@@ -72,7 +72,7 @@
         programme: programmes.first,
         patient:,
         parent: dad,
-        created_at: Time.zone.parse("2024-05-30 13:00")
+        submitted_at: Time.zone.parse("2024-05-30 13:00")
       )
 
       create(
@@ -251,7 +251,7 @@
         :self_consent,
         programme: programmes.first,
         patient:,
-        created_at: Time.zone.parse("2024-05-30 12:00")
+        submitted_at: Time.zone.parse("2024-05-30 12:00")
       )
     end
 
@@ -308,7 +308,7 @@
         programme: programmes.first,
         patient:,
         parent: mum,
-        created_at: Time.zone.local(2024, 5, 30, 12),
+        submitted_at: Time.zone.local(2024, 5, 30, 12),
         withdrawn_at: Time.zone.local(2024, 6, 30, 12)
       )
     end
@@ -333,7 +333,7 @@
         programme: programmes.first,
         patient:,
         parent: mum,
-        created_at: Time.zone.local(2024, 5, 30, 12),
+        submitted_at: Time.zone.local(2024, 5, 30, 12),
         invalidated_at: Time.zone.local(2024, 6, 30, 12)
       )
     end

spec/factories/consents.rb

@@ -12,6 +12,7 @@
 #  reason_for_refusal  :integer
 #  response            :integer          not null
 #  route               :integer          not null
+#  submitted_at        :datetime         not null
 #  withdrawn_at        :datetime
 #  created_at          :datetime         not null
 #  updated_at          :datetime         not null
@@ -71,6 +72,8 @@
       end
     end
 
+    submitted_at { consent_form&.recorded_at || Time.current }
+
     traits_for_enum :response
 
     trait :given_verbally do

spec/jobs/consent_form_matching_job_spec.rb

@@ -7,6 +7,7 @@
   let(:consent_form) do
     create(
       :consent_form,
+      :recorded,
       session:,
       given_name: "John",
       family_name: "Smith",
@@ -70,6 +71,7 @@
       let(:consent_form) do
         create(
           :consent_form,
+          :recorded,
           session:,
           given_name: "john",
           family_name: "SMITH",