Refactor pinned notes

Author: paulrobertlloyd

app/controllers/patient-session.js

@@ -1,5 +1,4 @@
 import {
-  AuditEventType,
   ConsentOutcome,
   ConsentWindow,
   InstructionOutcome,
@@ -20,7 +19,6 @@ import {
   Vaccination
 } from '../models.js'
 import { today } from '../utils/date.js'
-import { stringToBoolean } from '../utils/string.js'
 
 export const patientSessionController = {
   read(request, response, next, nhsn) {
@@ -378,15 +376,13 @@ export const patientSessionController = {
 
   note(request, response) {
     const { account } = request.app.locals
-    let { note, pinned } = request.body
+    const { note, pinned } = request.body
     const { data } = request.session
     const { __, back, patientSession } = response.locals
 
-    pinned = stringToBoolean(pinned)
-
     patientSession.saveNote({
-      name: pinned ? AuditEventType.Pinned : AuditEventType.SessionNote,
       note,
+      pinned,
       createdBy_uid: account.uid
     })
 

app/controllers/patient.js

@@ -2,7 +2,6 @@ import _ from 'lodash'
 
 import {
   ArchiveRecordReason,
-  AuditEventType,
   PatientStatus,
   ProgrammeType,
   SessionPresetName,
@@ -401,7 +400,6 @@ export const patientController = {
     const { __, patient } = response.locals
 
     patient.saveNote({
-      name: AuditEventType.RecordNote,
       note,
       createdBy_uid: account.uid
     })

app/enums.js

@@ -51,10 +51,9 @@ export const ArchiveRecordReason = {
  */
 export const AuditEventType = {
   Notice: 'Notice',
-  Pinned: 'Pinned session note',
   Reminder: 'Reminder',
   Record: 'Change to child record',
-  RecordNote: 'Note added to child record',
+  RecordNote: 'Child record note',
   SessionNote: 'Session note'
 }
 

app/models/audit-event.js

@@ -11,7 +11,8 @@ import { getScreenOutcomeStatus } from '../utils/status.js'
 import {
   formatTag,
   formatMarkdown,
-  formatWithSecondaryText
+  formatWithSecondaryText,
+  stringToBoolean
 } from '../utils/string.js'
 
 /**
@@ -23,6 +24,7 @@ import {
  * @property {string} [createdBy_uid] - User who created event
  * @property {string} name - Name
  * @property {string} [note] - Note
+ * @property {boolean} [pinned] - Pinned
  * @property {AuditEventType} [type] - Audit event type
  * @property {string} [outcome] - Outcome for activity type
  * @property {Date} [outcomeAt] - Date outcome invalidates
@@ -36,6 +38,7 @@ export class AuditEvent {
     this.createdBy_uid = options?.createdBy_uid
     this.name = options.name
     this.note = options.note
+    this.pinned = stringToBoolean(options?.pinned)
     this.type = options?.type
     this.outcome = options?.outcome
     this.outcomeAt = options?.outcomeAt && new Date(options.outcomeAt)

app/models/patient-session.js

@@ -180,7 +180,7 @@ export class PatientSession {
   get pinnedNotes() {
     return this.auditEvents
       .filter(({ programme_ids }) => programme_ids.includes(this.programme_id))
-      .filter(({ name }) => name === AuditEventType.Pinned)
+      .filter(({ pinned }) => pinned)
       .sort((a, b) => getDateValueDifference(b.createdAt, a.createdAt))
   }
 
@@ -1029,8 +1029,10 @@ export class PatientSession {
    */
   saveNote(event) {
     this.patient.addEvent({
-      name: event.name,
+      type: AuditEventType.SessionNote,
+      name: `${AuditEventType.SessionNote} added`,
       note: event.note,
+      pinned: event.pinned,
       createdBy_uid: event.createdBy_uid,
       programme_ids: this.session.programme_ids
     })

app/models/patient.js

@@ -234,7 +234,9 @@ export class Patient extends Child {
 
     return events
       .map((auditEvent) => new AuditEvent(auditEvent, this.context))
-      .filter(({ type }) => type === AuditEventType.Record)
+      .filter(({ type }) =>
+        [AuditEventType.Record, AuditEventType.RecordNote].includes(type)
+      )
   }
 
   /**
@@ -686,8 +688,8 @@ export class Patient extends Child {
    */
   saveNote(event) {
     this.addEvent({
-      type: AuditEventType.Record,
-      name: event.name,
+      type: AuditEventType.RecordNote,
+      name: `${AuditEventType.RecordNote} added`,
       note: event.note,
       createdBy_uid: event.createdBy_uid
     })