Merge pull request #4484 from nhsuk/add-reporting-api-vaccination-event-table-and-model

Add ReportingAPI::VaccinationEvent model

Author: Al Davidson

app/models/concerns/reporting_api/denormalizing_concern.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Convenience methods for initializing an instance of the including class
+# with a mix of simple-valued attributes (e.g. {name: 'a name', thing_id: 123} )
+# and named objects (e.g. patient: (instance of Patient) ).
+# This enables attributes to be copied from the given objects to the corresponding
+# scoped attributes on the model
+# Example:
+#  `obj = (class).new( name: 'my name', thing_id: 123, patient: (instance of patient) )`
+#  results in obj getting these attributes:
+#  ```
+#  name = 'my name',
+#  thing_id = 123,
+#  patient_id = (id of patient instance)
+#  patient_address_postcode = (postcode from patient instance)
+#  patient_given_name = (given_name of patient instance)
+#  ````
+#  ...etc
+module ReportingAPI::DenormalizingConcern
+  extend ActiveSupport::Concern
+
+  included do
+    def initialize(attrs = {})
+      attrs = attrs.to_h
+      references = attrs.select { |_, v| v.is_a?(ApplicationRecord) }
+      copy_attributes_from_references(references)
+
+      simple_valued_attrs = attrs.except(*references.keys)
+      super(**entries_which_exist_in_attributes(simple_valued_attrs))
+    end
+
+    def copy_attributes_from_references(references = {})
+      attr_set = self.class.attribute_names.to_set
+
+      references.each do |name, record|
+        if record
+          copy_scoped_attributes(name, record, attr_set)
+        else
+          attr_set.grep(/^#{name}_/).each { |k| self[k] = nil }
+        end
+      end
+    end
+
+    protected
+
+    # given a hash, return only the keys which exist in this class' attributes
+    def entries_which_exist_in_attributes(attrs = {})
+      attrs.slice(*self.class.attribute_names.map(&:to_sym)).symbolize_keys
+    end
+
+    # given a prefix and object like :school, (School object)
+    # copy each attribute from the given object to an attribute
+    # on self, prefixed with the prefix
+    # e.g. self.school_address_postcode = obj.postcode and so on
+    def copy_scoped_attributes(
+      prefix,
+      record,
+      attr_set = self.class.attribute_names.to_set
+    )
+      record.attributes&.each do |key, value|
+        attr_name = "#{prefix}_#{key}"
+        self[attr_name] = value if attr_set.include?(attr_name)
+      end
+    end
+  end
+end

app/models/concerns/reporting_api/event_concern.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ReportingAPI::EventConcern
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :source, polymorphic: true
+    belongs_to :patient
+
+    before_validation :set_patient_from_source,
+                      :set_event_timestamp_date_part_attributes,
+                      :set_patient_year_group
+
+    protected
+
+    def set_patient_from_source
+      self.patient = source.try(:patient)
+    end
+
+    def set_patient_year_group
+      self.patient_year_group =
+        patient.year_group(academic_year: event_timestamp.to_date.academic_year)
+    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
+
+    def self.count_sql_where(comparison:, as:)
+      "SUM(CASE WHEN #{comparison} THEN 1 ELSE 0 END) AS #{as}"
+    end
+  end
+end

app/models/reporting_api/vaccination_event.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: reporting_api_vaccination_events
+#
+#  id                                               :bigint           not null, primary key
+#  event_timestamp                                  :datetime         not null
+#  event_timestamp_academic_year                    :integer          not null
+#  event_timestamp_day                              :integer          not null
+#  event_timestamp_month                            :integer          not null
+#  event_timestamp_year                             :integer          not null
+#  event_type                                       :string           not null
+#  location_address_postcode                        :string
+#  location_address_town                            :string
+#  location_local_authority_mhclg_code              :string
+#  location_local_authority_short_name              :string
+#  location_name                                    :string
+#  location_type                                    :string
+#  organisation_name                                :string
+#  organisation_ods_code                            :string
+#  patient_address_postcode                         :string
+#  patient_address_town                             :string
+#  patient_birth_academic_year                      :integer
+#  patient_date_of_death                            :date
+#  patient_gender_code                              :string
+#  patient_home_educated                            :boolean
+#  patient_local_authority_from_postcode_mhclg_code :string
+#  patient_local_authority_from_postcode_short_name :string
+#  patient_school_address_postcode                  :string
+#  patient_school_address_town                      :string
+#  patient_school_gias_local_authority_code         :integer
+#  patient_school_local_authority_mhclg_code        :string
+#  patient_school_local_authority_short_name        :string
+#  patient_school_name                              :string
+#  patient_school_type                              :string
+#  patient_year_group                               :integer
+#  programme_type                                   :string
+#  source_type                                      :string           not null
+#  team_name                                        :string
+#  vaccination_record_outcome                       :string
+#  vaccination_record_performed_at                  :datetime
+#  vaccination_record_uuid                          :uuid
+#  created_at                                       :datetime         not null
+#  updated_at                                       :datetime         not null
+#  location_id                                      :bigint
+#  organisation_id                                  :bigint
+#  patient_id                                       :bigint           not null
+#  patient_school_id                                :bigint
+#  programme_id                                     :bigint
+#  source_id                                        :bigint           not null
+#  team_id                                          :bigint
+#  vaccination_record_programme_id                  :bigint
+#  vaccination_record_session_id                    :bigint
+#
+# Indexes
+#
+#  index_reporting_api_vaccination_events_on_source  (source_type,source_id)
+#  ix_rve_ac_year_month                              (event_timestamp_academic_year,event_timestamp_month)
+#  ix_rve_acyear_month_type                          (event_timestamp_academic_year,event_timestamp_month,event_type)
+#  ix_rve_prog_acyear_month                          (programme_id,event_timestamp_academic_year,event_timestamp_month)
+#  ix_rve_source_type_id                             (source_type,source_id)
+#  ix_rve_team_acyr_month                            (team_id,event_timestamp_academic_year,event_timestamp_month)
+#  ix_rve_tstamp                                     (event_timestamp)
+#
+class ReportingAPI::VaccinationEvent < ApplicationRecord
+  include ReportingAPI::DenormalizingConcern
+  include ReportingAPI::EventConcern
+
+  def self.with_counts_of_outcomes
+    select(
+      count_sql_where(
+        comparison: "vaccination_record_outcome = 'administered'",
+        as: "total_vaccinations_performed"
+      )
+    )
+  end
+
+  def self.with_count_of_patients_vaccinated
+    # We want a count of just the distinct patient_ids
+    # for whom the outcome was 'administered'.
+    # If the outcome was not 'administered', this count should not include them
+    select(<<-SQL)
+        COUNT(
+          DISTINCT(
+            CASE WHEN vaccination_record_outcome = 'administered'
+            THEN patient_id 
+            ELSE NULL 
+            END
+          )
+        ) AS total_patients_vaccinated
+      SQL
+  end
+end

db/migrate/20250827100519_add_reporting_api_vaccination_events.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class AddReportingAPIVaccinationEvents < ActiveRecord::Migration[8.0]
+  def change
+    create_table :reporting_api_vaccination_events do |t|
+      t.string :event_type, null: false
+      t.datetime :event_timestamp, null: false
+      t.integer :event_timestamp_year, null: false
+      t.integer :event_timestamp_month, null: false
+      t.integer :event_timestamp_day, null: false
+      t.integer :event_timestamp_academic_year, null: false
+
+      t.references :source, polymorphic: true, null: false
+
+      t.bigint :patient_id, null: false
+
+      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.bigint :patient_school_id
+      t.string :patient_school_name
+      t.string :patient_school_address_town
+      t.string :patient_school_address_postcode
+      t.integer :patient_school_gias_local_authority_code
+      t.string :patient_school_type
+
+      t.string :patient_school_local_authority_mhclg_code
+      t.string :patient_school_local_authority_short_name
+
+      t.string :patient_local_authority_from_postcode_mhclg_code
+      t.string :patient_local_authority_from_postcode_short_name
+
+      t.bigint :location_id
+      t.string :location_name
+      t.string :location_address_town
+      t.string :location_address_postcode
+      t.string :location_type
+
+      t.string :location_local_authority_mhclg_code
+      t.string :location_local_authority_short_name
+
+      t.bigint :team_id
+      t.string :team_name
+
+      t.bigint :organisation_id
+      t.string :organisation_ods_code
+      t.string :organisation_name
+
+      t.string :vaccination_record_outcome
+      t.uuid :vaccination_record_uuid
+      t.datetime :vaccination_record_performed_at
+      t.bigint :vaccination_record_programme_id
+      t.bigint :vaccination_record_session_id
+
+      t.bigint :programme_id
+      t.string :programme_type
+
+      t.timestamps
+
+      t.index [:event_timestamp], name: "ix_rve_tstamp"
+      t.index %i[event_timestamp_academic_year event_timestamp_month],
+              name: "ix_rve_ac_year_month"
+      t.index %i[source_type source_id], name: "ix_rve_source_type_id"
+      t.index %i[
+                event_timestamp_academic_year
+                event_timestamp_month
+                event_type
+              ],
+              name: "ix_rve_acyear_month_type"
+      t.index %i[
+                programme_id
+                event_timestamp_academic_year
+                event_timestamp_month
+              ],
+              name: "ix_rve_prog_acyear_month"
+      t.index %i[team_id event_timestamp_academic_year event_timestamp_month],
+              name: "ix_rve_team_acyr_month"
+    end
+  end
+end