Reorganise the parent details for clinic bookings

This commit moves the Parent object to the ClinicBooking, removing it from the ClinicAppointment (but adding parental relationship properties to the appointment). This should simplify various areas, removing the need to propagate contact details to multiple appointments in the same booking.

The changes here required changes to the generation of fake data too and triggered a bit of fixing.

Author: malross

app/controllers/book-into-a-clinic.js

@@ -9,6 +9,7 @@ import { kebabToCamelCase } from '../utils/string.js'
 export const bookIntoClinicController = {
   /**
    * Record the session preset
+   *
    * @param {*} request
    * @param {*} response
    * @param {*} next
@@ -164,7 +165,7 @@ export const bookIntoClinicController = {
         {
           [`/${session_preset_slug}/new/${appointment_uuid}/vaccination-choice`]:
             {
-              data: 'appointment.parent.hasParentalResponsibility',
+              data: 'appointment.parentHasParentalResponsibility',
               value: 'true'
             }
         },
@@ -203,7 +204,7 @@ export const bookIntoClinicController = {
       // Parent journey
       [`/${session_preset_slug}/${booking_uuid}/new/parent`]: {
         [`/${session_preset_slug}/${booking_uuid}/new/offer-health-questions`]:
-          () => !booking?.parentTel
+          () => !booking?.parent?.tel
       },
       [`/${session_preset_slug}/${booking_uuid}/new/contact-preference`]: {},
 

app/generators/clinic-appointment.js

@@ -3,33 +3,31 @@ import { addMinutes } from 'date-fns'
 import _ from 'lodash'
 
 import { ParentalRelationship, SessionType } from '../enums.js'
-import { ClinicAppointment, Parent } from '../models.js'
+import { ClinicAppointment } from '../models.js'
 import { getAge } from '../utils/date.js'
 
-import { generateParent } from './parent.js'
-
 const clinicSlotLength = Number(process.env.CLINIC_SLOT_LENGTH) || 10
 
 /**
  * Generate fake clinic appointment
  *
- * @param {string} booking_uuid - The UUID of the booking this appointment belongs to
- * @param {Parent|null} parentFromFirstAppointment - The parent from the first appointment created in the same booking, if this appointment is not the first
+ * @param {ClinicBooking} booking - The booking this appointment will belong to
  * @param {object} context - The other data already defined (sessions, children, etc.)
  * @returns {ClinicAppointment} A new, fake clinic appointment
  */
-export function generateClinicAppointment(
-  booking_uuid,
-  parentFromFirstAppointment,
-  context
-) {
+export function generateClinicAppointment(booking, context) {
   const uuid = faker.string.uuid()
 
   // Choose a clinic session to book this appointment into
   const clinicSessions = Object.values(context.sessions).filter(
-    (s) => s.type === SessionType.Clinic
+    (s) =>
+      s.type === SessionType.Clinic &&
+      s.presetNames.includes(booking.sessionPreset.name)
   )
   const clinicSession = faker.helpers.arrayElement(clinicSessions)
+  if (!clinicSession) {
+    return null
+  }
   const session_id = clinicSession.id
 
   // Work out the expected age range for children attending this session
@@ -60,80 +58,87 @@ export function generateClinicAppointment(
     ? undefined
     : faker.date.birthdate({ min: minAge, max: maxAge, mode: 'age' })
 
-  // Parent details and relationship
-  let parent
-  if (!parentFromFirstAppointment) {
-    // This is the first appointment for the booking, so we're free to CREATE the parent details
-    if (matchedPatient) {
-      parent =
-        (matchedPatient.parent1 || matchedPatient.parent2) ??
-        generateParent(matchedPatient.lastName, faker.datatype.boolean(0.5))
-    } else {
-      parent = generateParent(unmatchedLastName, faker.datatype.boolean(0.5))
-    }
-  } else {
-    // Copy parent details from the first appointment and possibly adapt the relationship
-    parent = new Parent(parentFromFirstAppointment)
-    parent.uuid = faker.string.uuid()
-
-    // Set up the relationship to the child for this appointment
-    if (
-      [ParentalRelationship.Mum, ParentalRelationship.Dad].includes(
-        parentFromFirstAppointment.relationship
-      )
-    ) {
+  // Set up the relationship to the child for this appointment
+  const parent = booking.parent
+  let parentalRelationship,
+    parentalRelationshipOther,
+    parentHasParentalResponsibility
+  if (parent) {
+    const mumOrDad = [
+      ParentalRelationship.Mum,
+      ParentalRelationship.Dad
+    ].includes(parent.relationship)
+    if (mumOrDad) {
       // Mum or Dad initially, and most likely to stay that way
       if (faker.datatype.boolean(0.1)) {
-        parent.relationship = faker.helpers.arrayElement([
+        parentalRelationship = faker.helpers.arrayElement([
           ParentalRelationship.Fosterer,
           ParentalRelationship.Guardian,
           ParentalRelationship.Other
         ])
-        parent.relationshipOther =
-          parent.relationship === ParentalRelationship.Other
+        parentalRelationshipOther =
+          parentalRelationship === ParentalRelationship.Other
             ? 'Grandparent'
             : undefined
+        parentHasParentalResponsibility = true
       }
     } else {
       // Fosterer, Guardian or Other
-      parent.relationship = parentFromFirstAppointment.relationship
-      parent.relationshipOther = parentFromFirstAppointment.relationshipOther
+      parentalRelationship = parent.relationship
+      parentalRelationshipOther = parent.relationshipOther
+      parentHasParentalResponsibility = parent.hasParentalResponsibility
     }
   }
 
   // Slot details (NB: session date is expected to specify midday)
+  const needsExtraTime = faker.datatype.boolean(0.2)
+  let extraTimeReason
+  if (needsExtraTime) {
+    const phobia = faker.helpers.weightedArrayElement([
+      { value: 'needles', weight: 90 },
+      { value: 'nurses', weight: 8 },
+      { value: 'vaccines', weight: 2 }
+    ])
+    extraTimeReason = `Suffers from anxiety regarding ${phobia}`
+  }
   const startAt = addMinutes(
     clinicSession.date,
     faker.number.int({ min: 0, max: 60, multipleOf: clinicSlotLength })
   )
-  const endAt = addMinutes(startAt, clinicSlotLength)
+  const endAt = addMinutes(startAt, clinicSlotLength * (needsExtraTime ? 2 : 1))
 
   // Have the child signed up for the clinic's primary programme plus a random selection of other programmes
+  const primary_programme_ids = clinicSession.programme_ids
   const additionalProgramme_ids = Object.values(context.programmes)
     .filter((p) => p.hidden !== true)
     .map((p) => p.id)
     .filter(
       (id) =>
         !clinicSession.programme_ids.includes(id) && faker.datatype.boolean(0.2)
     )
-  const programme_ids = [
-    ...clinicSession.programme_ids,
+  const selected_programme_ids = [
+    ...primary_programme_ids,
     ...additionalProgramme_ids
   ]
 
   return new ClinicAppointment(
     {
       uuid,
-      booking_uuid,
+      booking_uuid: booking.uuid,
       patient_uuid,
       unmatchedFirstName,
       unmatchedLastName,
       unmatchedDob,
-      parent,
+      needsExtraTime,
+      extraTimeReason,
+      parentalRelationship,
+      parentalRelationshipOther,
+      parentHasParentalResponsibility,
       session_id,
       startAt,
       endAt,
-      programme_ids
+      selected_programme_ids,
+      primary_programme_ids
     },
     context
   )

app/generators/clinic-booking.js

@@ -1,5 +1,6 @@
 import { fakerEN_GB as faker } from '@faker-js/faker'
 
+import { SessionPresets } from '../enums.js'
 import { ClinicBooking } from '../models.js'
 
 /**
@@ -11,11 +12,13 @@ import { ClinicBooking } from '../models.js'
 export function generateEmptyClinicBooking(context) {
   const uuid = faker.string.uuid()
   const bookingReference = ClinicBooking.generateReference()
+  const sessionPreset = faker.helpers.arrayElement(SessionPresets)
 
   return new ClinicBooking(
     {
       uuid,
-      bookingReference
+      bookingReference,
+      sessionPreset
     },
     context
   )

app/models/clinic-appointment.js

@@ -30,11 +30,13 @@ import {
  * @property {object} [unmatchedDob_] - Child date of birth, if not matched to a patient record (for use with decorate)
  * @property {Boolean} needsExtraTime - Does the child need extra time for their vaccinations?
  * @property {string} [extraTimeReason] - The reason why the child needs extra time for their appointment
- * @property {Parent} [parent] - The parent/carer who booked this appointment
+ * @property {ParentalRelationship} [parentalRelationship] - The relationship of the person booking the appointment to the child
+ * @property {string} [parentalRelationshipOther] - User-defined parental relationship to the child for this appointment
+ * @property {boolean} [parentHasParentalResponsibility] - Does the parent/carer have legal parental responsibility for the child?
  * @property {string} [session_id] - The ID of the clinic session in which the appointment's booked
  * @property {Date} [startAt] - Slot start time
  * @property {Date} [endAt] - Slot end time
- * @property {Array<string>} [primary_programme_ids] - IDs of programmes signed up for
+ * @property {Array<string>} [primary_programme_ids] - IDs of primary programmes for this clinic booking
  * @property {Array<string>} [selected_programme_ids] - IDs of programmes signed up for
  * @property {object} [healthAnswers] - Answers to health questions
  */
@@ -53,7 +55,10 @@ export class ClinicAppointment {
     this.needsExtraTime = options?.needsExtraTime
     this.extraTimeReason = options?.extraTimeReason
 
-    this.parent = options?.parent && new Parent(options.parent)
+    this.parentalRelationship = options?.parentalRelationship
+    this.parentalRelationshipOther = options?.parentalRelationshipOther
+    this.parentHasParentalResponsibility =
+      options?.parentHasParentalResponsibility
 
     this.session_id = options?.session_id
     this.startAt = options?.startAt ? new Date(options.startAt) : undefined
@@ -120,17 +125,49 @@ export class ClinicAppointment {
     }
   }
 
+  /**
+   * Get a parent object combining the parent's contact details held in the
+   * booking with the parental relationship for this appointment's child
+   */
+  get parent() {
+    const booking = this.clinicBooking
+    if (booking) {
+      const parent = new Parent(booking.parent)
+      return _.merge(parent, {
+        relationship: this.parentalRelationship,
+        relationshipOther: this.parentalRelationshipOther,
+        hasParentalResponsibility: this.parentHasParentalResponsibility
+      })
+    }
+
+    return undefined
+  }
+
+  /**
+   * Get first name of the child booked into this appointment
+   *
+   * @returns {string} Child's first name
+   */
+  get firstName() {
+    return this.patient ? this.patient.firstName : this.unmatchedFirstName
+  }
+
+  /**
+   * Get last name of the child booked into this appointment
+   *
+   * @returns {string} Child's last name
+   */
+  get lastName() {
+    return this.patient ? this.patient.lastName : this.unmatchedLastName
+  }
+
   /**
    * Get full name of the child booked into this appointment
    *
    * @returns {string} Child's full name
    */
   get fullName() {
-    const patient = this.patient
-    if (patient) {
-      return `${patient.firstName} ${patient.lastName}`
-    }
-    return `${this.unmatchedFirstName} ${this.unmatchedLastName}`
+    return `${this.firstName} ${this.lastName}`
   }
 
   /**

app/models/clinic-booking.js

@@ -3,7 +3,7 @@ import _ from 'lodash'
 
 import allProgrammesData from '../datasets/programmes.js'
 import { SessionPresets } from '../enums.js'
-import { ClinicAppointment, Programme } from '../models.js'
+import { ClinicAppointment, Parent, Programme } from '../models.js'
 
 /**
  * @class ClinicBooking
@@ -13,7 +13,7 @@ import { ClinicAppointment, Programme } from '../models.js'
  * @property {string} uuid - Clinic booking UUID
  * @property {string} bookingReference - Booking reference number
  * @property {SessionPreset} sessionPreset - the primary programme for which the parent was invited to book e.g. doubles
- * @property {number} childCount - the number of children that the parent wants to book in in one go
+ * @property {Parent} parent - contact details for the parent making the booking; see appointments for parental relationship details
  * @property {Array<string>} [appointments_ids] - Unique IDs of children's appointments (one parent may book in multiple children under one booking)
  */
 export class ClinicBooking {
@@ -23,8 +23,9 @@ export class ClinicBooking {
     this.bookingReference =
       options?.bookingReference || ClinicBooking.generateReference()
     this.sessionPreset = options?.sessionPreset ?? SessionPresets[0]
+    this.parent =
+      (options?.parent && new Parent(options.parent)) ?? new Parent({})
 
-    this.childCount = options?.childCount
     this.appointments_ids = options?.appointments_ids ?? []
   }
 
@@ -114,35 +115,6 @@ export class ClinicBooking {
     )
   }
 
-  /**
-   * Get the parent details from the first appointment
-   *
-   * This is only intended to allow us to present the parent's name, email and so on, but not to
-   * represent the parent's relationship to all the children in this booking, as the relationship
-   * may vary by chiuld.
-   *
-   * @returns {Parent|undefined} Parent details from the first appointment
-   */
-  get firstParent() {
-    return this.appointments?.[0]?.parent
-  }
-
-  /**
-   *
-   */
-  set parentTel(value) {
-    if (value) {
-      this.appointments.forEach((appt) => (appt.parent.tel = value))
-    }
-  }
-
-  /**
-   *
-   */
-  get parentTel() {
-    return this.firstParent?.tel
-  }
-
   /**
    * Get various formatted values for display in the page
    *

app/views/book-into-a-clinic/form/contact-preference.njk

@@ -20,12 +20,12 @@
       conditional: {
         html: textarea({
           label: { text: __("clinicBooking.parent.contactPreferenceDetails.label") },
-          decorate: "booking.parentContactPreferenceDetails"
+          decorate: "booking.parent.contactPreferenceDetails"
         })
       }
     }, {
       text: __("clinicBooking.parent.contactPreference.no")
     }],
-    decorate: "booking.parentContactPreference"
+    decorate: "booking.parent.contactPreference"
   }) }}
 {% endblock %}