Per programme clinic invitations, with filters

Author: paulrobertlloyd

app/controllers/patient.js

@@ -66,7 +66,8 @@ export const patientController = {
   },
 
   readAll(request, response, next) {
-    const { option, programme_id, q, yearGroup } = request.query
+    const { invitedToClinic, option, programme_id, q, yearGroup } =
+      request.query
     const { data } = request.session
 
     const programmes = Programme.findAll(data)
@@ -120,6 +121,19 @@ export const patientController = {
       )
     }
 
+    // Filter by programme clinic invitations
+    if (programme_id && invitedToClinic === 'true') {
+      results = results.filter(
+        (patient) => patient.programmes[programme_id]?.invitedToClinic
+      )
+    } else if (invitedToClinic === 'true') {
+      results = results.filter((patient) =>
+        Object.values(patient.programmes).some(
+          (programme) => programme.invitedToClinic
+        )
+      )
+    }
+
     // Filter by status
     if (filters.report && filters.report !== 'none') {
       const ids = programme_ids || programmes.map((programme) => programme.id)
@@ -196,6 +210,7 @@ export const patientController = {
     }))
 
     // Clean up session data
+    delete data.invitedToClinic
     delete data.option
     delete data.patientConsent
     delete data.patientDeferred
@@ -233,6 +248,7 @@ export const patientController = {
 
     // Checkboxes
     for (const key of [
+      'invitedToClinic',
       'option',
       'patientConsent',
       'patientDeferred',

app/controllers/school.js

@@ -2,7 +2,7 @@ import wizard from '@x-govuk/govuk-prototype-wizard'
 import _ from 'lodash'
 
 import { PatientStatus } from '../enums.js'
-import { School } from '../models.js'
+import { Patient, School } from '../models.js'
 import { generateNewSiteCode } from '../utils/location.js'
 import { getResults, getPagination } from '../utils/pagination.js'
 import { formatYearGroup } from '../utils/string.js'
@@ -96,7 +96,8 @@ export const schoolController = {
   },
 
   readPatients(request, response, next) {
-    const { option, programme_id, q, yearGroup } = request.query
+    const { invitedToClinic, option, programme_id, q, yearGroup } =
+      request.query
     const { data } = request.session
     const { school } = response.locals
 
@@ -145,6 +146,19 @@ export const schoolController = {
       )
     }
 
+    // Filter by programme clinic invitations
+    if (programme_id && invitedToClinic === 'true') {
+      results = results.filter(
+        (patient) => patient.programmes[programme_id]?.invitedToClinic
+      )
+    } else if (invitedToClinic === 'true') {
+      results = results.filter((patient) =>
+        Object.values(patient.programmes).some(
+          (programme) => programme.invitedToClinic
+        )
+      )
+    }
+
     // Filter by status
     if (filters.report && filters.report !== 'none') {
       const ids =
@@ -223,6 +237,7 @@ export const schoolController = {
     }))
 
     // Clean up session data
+    delete data.invitedToClinic
     delete data.option
     delete data.patientConsent
     delete data.patientDeferred
@@ -252,6 +267,7 @@ export const schoolController = {
 
     // Checkboxes
     for (const key of [
+      'invitedToClinic',
       'option',
       'patientConsent',
       'patientDeferred',
@@ -464,7 +480,14 @@ export const schoolController = {
       (patient) => patient.uuid
     )
 
-    // TODO: Move patients to clinic
+    // Invite parents to book into a clinic
+    for (const patient of school.patients) {
+      const clinicProgramme_ids = request.body.clinicProgramme_ids.filter(
+        (item) => item !== '_unchecked'
+      )
+
+      Patient.update(patient.uuid, { clinicProgramme_ids }, data)
+    }
 
     request.flash(
       'success',

app/datasets/schools.js

@@ -12,13 +12,15 @@ export default {
     id: '888888',
     urn: '888888',
     name: 'Unknown school',
+    yearGroups: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13],
     team_id: '001',
     presetNames
   },
   '999999': {
     id: '999999',
     urn: '999999',
     name: 'Home-schooled',
+    yearGroups: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13],
     team_id: '001',
     presetNames
   },

app/locales/en.js

@@ -1083,6 +1083,9 @@ export const en = {
     programmes: {
       label: 'Vaccination programmes'
     },
+    clinicProgramme_ids: {
+      label: 'Clinic invitations'
+    },
     status: {
       label: 'Status'
     }
@@ -1539,9 +1542,17 @@ export const en = {
       title: 'Invite parents to book a clinic appointment',
       label: 'Send clinic invitations',
       count:
-        '{count, plural, =0 {No children} one {1 child} other {# children}} have not been vaccinated. They have not been invited to a clinic yet.',
+        '{count, plural, =0 {No children} one {1 child} other {# children}} are due a vaccination for at least 1 programme. They have not been invited to a clinic yet.',
       description:
         'You can now send clinic booking invitations to their parents.\n\nThe next clinic is on %s.',
+      programme: 'Which programmes are you running at the clinic?',
+      flu: '{count, plural, =0 {No children} one {1 child} other {# children}} have not had a flu vaccination',
+      hpv: '{count, plural, =0 {No children have} one {1 child has} other {# children have}} not had an HPV vaccination',
+      menacwy:
+        '{count, plural, =0 {No children have} one {1 child has} other {# children have}} not had an MenACWY vaccination',
+      mmr: '{count, plural, =0 {No children have} one {1 child has} other {# children have}} not had an MMR vaccination',
+      'td-ipv':
+        '{count, plural, =0 {No children have} one {1 child has} other {# children have}} not had a Td/IPV vaccination',
       confirm: 'Send clinic invitations',
       success:
         '{count, plural, =0 {No children} one {1 child} other {# children}} invited to the clinic'

app/models/patient-programme.js

@@ -25,12 +25,14 @@ import {
  * @param {object} options - Options
  * @param {object} [context] - Global context
  * @property {object} [context] - Global context
+ * @property {boolean} [invitedToClinic] - Invited to clinic
  * @property {string} patient_uuid - Patient UUID
  * @property {string} programme_id - Programme ID
  */
 export class PatientProgramme {
   constructor(options, context) {
     this.context = context
+    this.invitedToClinic = options?.invitedToClinic
     this.patient_uuid = options?.patient_uuid
     this.programme_id = options?.programme_id
   }

app/models/patient.js

@@ -11,6 +11,7 @@ import {
   Parent,
   PatientProgramme,
   PatientSession,
+  Programme,
   Reply,
   Vaccination
 } from '../models.js'
@@ -45,6 +46,7 @@ import {
  * @property {Patient} [pendingChanges] - Pending changes to record values
  * @property {import('../enums.js').ArchiveRecordReason} [archiveReason] - Archival reason
  * @property {string} [archiveReasonOther] - Other archival reason
+ * @property {Array<string} [clinicProgramme_ids] - Clinic programme invitations
  * @property {Array<import('./audit-event.js').AuditEvent>} events - Events
  * @property {Array<string>} [reply_uuids] - Reply IDs
  * @property {Array<string>} [patientSession_uuids] - Patient session IDs
@@ -71,6 +73,7 @@ export class Patient extends Child {
     this.archiveReasonOther = options?.archiveReasonOther
     this.pendingChanges = options?.pendingChanges || {}
 
+    this.clinicProgramme_ids = options?.clinicProgramme_ids || []
     this.events = options?.events || []
     this.reply_uuids = options?.reply_uuids || []
     this.patientSession_uuids = options?.patientSession_uuids || []
@@ -304,13 +307,20 @@ export class Patient extends Child {
     for (const programme of Object.values(programmesData).filter(
       (programme) => !programme.hidden
     )) {
-      programmes[programme.id] = new PatientProgramme(
+      const patientProgramme = new PatientProgramme(
         {
           patient_uuid: this.uuid,
           programme_id: programme.id
         },
         this.context
       )
+
+      // Patient invited to clinic if invitation needed and invitation sent
+      patientProgramme.invitedToClinic =
+        patientProgramme.inviteToSession &&
+        this.clinicProgramme_ids.includes(programme.id)
+
+      programmes[programme.id] = patientProgramme
     }
 
     return programmes
@@ -449,7 +459,10 @@ export class Patient extends Child {
       archiveReason: formatOther(this.archiveReasonOther, this.archiveReason),
       lastReminderDate: this.lastReminderDate
         ? `Last reminder sent on ${this.lastReminderDate}`
-        : 'No reminders sent'
+        : 'No reminders sent',
+      clinicProgramme_ids: this.clinicProgramme_ids
+        .map((id) => Programme.findOne(id, this.context).nameTag)
+        .join(' ')
     }
   }
 

app/models/school.js

@@ -91,6 +91,18 @@ export class School extends Location {
     return this.patients.filter((patient) => patient.hasMissingNhsNumber)
   }
 
+  /**
+   * Get school pupils to invite to a (clinic) session
+   *
+   * @param {string} programmeId - Programme ID
+   * @returns {Array<Patient>} Patient records
+   */
+  patientsToInviteToSession(programmeId) {
+    return this.patients.filter(
+      (patient) => patient.programmes[programmeId].inviteToSession
+    )
+  }
+
   /**
    * Get sessions run at this school
    *

app/views/_macros/patient-search.njk

@@ -62,6 +62,21 @@
       decorate: "programme_id"
     }) if programmeItems }}
 
+    {{ checkboxes({
+      classes: "nhsuk-checkboxes--small",
+      fieldset: {
+        legend: {
+          classes: "nhsuk-fieldset__legend--s",
+          text: __("patient.clinicProgramme_ids.label")
+        }
+      },
+      items: [{
+        text: 'Invited to clinic',
+        value: 'true'
+      }],
+      decorate: "invitedToClinic"
+    }) }}
+
     {% for name, enums in params.checkboxFilters %}
       {{ checkboxes({
         classes: "nhsuk-checkboxes--small",

app/views/patient/list.njk

@@ -74,6 +74,7 @@
                 value: patient.school.name | highlightQuery(data.q)
               },
               yearGroup: {},
+              clinicProgramme_ids: {},
               report: {
                 label: __("patientSession.report.label"),
                 value: reportStatusHtml

app/views/school/invite-to-clinic.njk

@@ -14,4 +14,55 @@
   }) | nhsukMarkdown }}
 
   {{ __("school.inviteToClinic.description", "1 June 2026") | nhsukMarkdown }}
+
+  {{ checkboxes({
+    fieldset: {
+      legend: {
+        text: __("school.inviteToClinic.programme"),
+        size: "m"
+      }
+    },
+    items: [{
+      text: ProgrammeType.Flu,
+      value: "flu",
+      hint: {
+        text: __mf("school.inviteToClinic.flu", {
+          count: school.patientsToInviteToSession('flu').length
+        })
+      }
+    }, {
+      text: ProgrammeType.HPV,
+      value: "hpv",
+      hint: {
+        text: __mf("school.inviteToClinic.hpv", {
+          count: school.patientsToInviteToSession('hpv').length
+        })
+      }
+    }, {
+      text: ProgrammeType.MenACWY,
+      value: "menacwy",
+      hint: {
+        text: __mf("school.inviteToClinic.menacwy", {
+          count: school.patientsToInviteToSession('menacwy').length
+        })
+      }
+    }, {
+      text: ProgrammeType.MMR,
+      value: "mmr",
+      hint: {
+        text: __mf("school.inviteToClinic.mmr", {
+          count: school.patientsToInviteToSession('mmr').length
+        })
+      }
+    }, {
+      text: ProgrammeType.TdIPV,
+      value: "td-ipv",
+      hint: {
+        text: __mf("school.inviteToClinic.td-ipv", {
+          count: school.patientsToInviteToSession('td-ipv').length
+        })
+      }
+    }],
+    decorate: "clinicProgramme_ids"
+  }) }}
 {% endblock %}