Update: [AEA-4048] - Validate terminal status indicator value

packages/specification/examples/request-multiple-items.json

@@ -15,7 +15,7 @@
             }
           }
         ],
-        "status": "in-progress",
+        "status": "completed",
         "businessStatus": {
           "coding": [
             {

packages/updatePrescriptionStatus/src/validation/content.ts

@@ -1,11 +1,6 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import {
-  BundleEntry,
-  CodeableConcept,
-  Coding,
-  Task
-} from "fhir/r4"
+/* eslint-disable @typescript-eslint/no-explicit-any, max-len */
+
+import {BundleEntry, Task} from "fhir/r4"
 import {validatePrescriptionID} from "../utils/prescriptionID"
 import {validateNhsNumber} from "../utils/nhsNumber"
 import {validateFields} from "./fields"
@@ -25,18 +20,20 @@ export const ODS_CODE_CODESYSTEM = "https://fhir.nhs.uk/Id/ods-organization-code
 export const PRESCRIPTION_ID_CODESYSTEM = "https://fhir.nhs.uk/Id/prescription-order-number"
 export const STATUS_CODESYSTEM = "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt"
 
-export const BUSINESS_STATUSES = [
+export const COMPLETED_BUSINESS_STATUSES = ["collected", "not dispensed", "dispatched"]
+
+export const IN_PROGRESS_BUSINESS_STATUSES = [
   "with pharmacy",
   "with pharmacy - preparing remainder",
   "ready to collect",
-  "ready to collect - partial",
-  "collected",
-  "ready to dispatch",
-  "ready to dispatch - partial",
-  "dispatched",
-  "not dispensed"
+  "ready to collect - partial"
 ]
 
+export const BUSINESS_STATUSES = COMPLETED_BUSINESS_STATUSES.concat(IN_PROGRESS_BUSINESS_STATUSES, [
+  "ready to dispatch",
+  "ready to dispatch - partial"
+])
+
 export function transactionBundle(body: any): boolean {
   return body.resourceType === "Bundle" && body.type === "transaction"
 }
@@ -113,15 +110,14 @@ export function businessStatus(task: Task): string | undefined {
 
 export function statuses(task: Task): string | undefined {
   const status = task.status
-  if (status === "completed") {
-    const businessStatus: CodeableConcept | undefined = task.businessStatus
-    if (businessStatus) {
-      const coding: Coding = businessStatus.coding![0]
-      const code = coding.code
-      if (code && ["with pharmacy", "ready to collect"].includes(code.toLowerCase())) {
-        return "Completed state indicated for a prescription status requiring patient action."
-      }
-    }
+  const businessStatus: string = task.businessStatus!.coding![0].code!
+  const lowercaseCode = businessStatus.toLowerCase()
+  if (status === "completed" && IN_PROGRESS_BUSINESS_STATUSES.includes(lowercaseCode)) {
+    return `Task.status field set to '${status}' but Task.businessStatus value of '${businessStatus}' requires follow up action.`
+  } else if (status === "in-progress" && COMPLETED_BUSINESS_STATUSES.includes(lowercaseCode)) {
+    return `Task.status field set to '${status}' but Task.businessStatus value of '${businessStatus}' has no possible follow up action.`
+  } else if (!BUSINESS_STATUSES.includes(lowercaseCode)) {
+    return `Unsupported Task.businessStatus '${businessStatus}'.`
   }
 }
 

packages/updatePrescriptionStatus/tests/utils/testUtils.ts

@@ -34,7 +34,7 @@ const TASK_VALUES = [
     odsCode: "C9Z1O",
     lineItemID: "6989b7bd-8db6-428c-a593-4022e3044c00",
     id: TASK_ID_0,
-    status: "in-progress",
+    status: "completed",
     businessStatus: "Dispatched",
     lastModified: "2023-09-11T10:11:12Z"
   },

packages/updatePrescriptionStatus/tests/validation/testRequestContentValidation.test.ts

@@ -1,4 +1,4 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable  max-len */
 
 import {
   expect,
@@ -211,42 +211,70 @@ describe("Unit tests for validation of NHS number", () => {
 })
 
 describe("Unit tests for validation of status against business status", () => {
-  it.each([
-    {
-      taskStatus: "completed",
-      businessStatus: "With Pharmacy",
-      expected: "Completed state indicated for a prescription status requiring patient action."
-    },
-    {
-      taskStatus: "completed",
-      businessStatus: "Ready to collect",
-      expected: "Completed state indicated for a prescription status requiring patient action."
-    },
-    {
-      taskStatus: "completed",
-      businessStatus: "ReAdY tO cOlLeCt",
-      expected: "Completed state indicated for a prescription status requiring patient action."
-    },
-    {
-      taskStatus: "in-progress",
-      businessStatus: "With Pharmacy",
-      expected: undefined
-    },
-    {
-      taskStatus: "in-progress",
-      businessStatus: "Ready to collect",
-      expected: undefined
-    }
-  ])(
-    "When status is '$status' and business status is '$businessStatus', should return expected issue.",
-    async ({taskStatus, businessStatus, expected}) => {
-      const task = {status: taskStatus, businessStatus: {coding: [{code: businessStatus}]}}
+  describe("When task status is 'completed'", () => {
+    it.each([
+      {isValid: false, businessStatus: "With Pharmacy"},
+      {isValid: false, businessStatus: "With Pharmacy - preparing remainder"},
+      {isValid: false, businessStatus: "Ready to collect"},
+      {isValid: false, businessStatus: "ReAdY tO cOlLeCt"},
+      {isValid: false, businessStatus: "Ready to collect - partial"},
+      {isValid: false, businessStatus: "rEaDy To ColLEcT - pArtIAl"},
+      {isValid: true, businessStatus: "Collected"},
+      {isValid: true, businessStatus: "Not dispensed"},
+      {isValid: true, businessStatus: "Dispatched"},
+      {isValid: true, businessStatus: "Ready to dispatch"},
+      {isValid: true, businessStatus: "Ready to dispatch - partial"}
+    ])(
+      "When status is 'completed' and business status is '$businessStatus', should return expected issue.",
+      ({isValid, businessStatus}) => {
+        const task = {status: "completed", businessStatus: {coding: [{code: businessStatus}]}}
+        const actual = statuses(task as Task)
+        const expected = isValid
+          ? undefined
+          : `Task.status field set to 'completed' but Task.businessStatus value of '${businessStatus}' requires follow up action.`
+        expect(actual).toEqual(expected)
+      }
+    )
+  })
 
-      const actual = statuses(task as Task)
+  describe("When task status is 'in-progress'", () => {
+    it.each([
+      {isValid: true, businessStatus: "With Pharmacy"},
+      {isValid: true, businessStatus: "With Pharmacy - preparing remainder"},
+      {isValid: true, businessStatus: "Ready to collect"},
+      {isValid: true, businessStatus: "Ready to collect - partial"},
+      {isValid: true, businessStatus: "Ready to dispatch"},
+      {isValid: true, businessStatus: "Ready to dispatch - partial"},
+      {isValid: false, businessStatus: "Collected"},
+      {isValid: false, businessStatus: "Not dispensed"},
+      {isValid: false, businessStatus: "Dispatched"}
+    ])(
+      "When status is 'in-progress' and business status is '$businessStatus', should return expected issue.",
+      ({isValid, businessStatus}) => {
+        const task = {status: "in-progress", businessStatus: {coding: [{code: businessStatus}]}}
+        const actual = statuses(task as Task)
+        const expected = isValid
+          ? undefined
+          : `Task.status field set to 'in-progress' but Task.businessStatus value of '${businessStatus}' has no possible follow up action.`
+        expect(actual).toEqual(expected)
+      }
+    )
+  })
 
-      expect(actual).toEqual(expected)
-    }
-  )
+  describe("When business status is unsupported", () => {
+    it.each([
+      {status: "completed", businessStatus: "unsupported-status"},
+      {status: "in-progress", businessStatus: "another-unsupported-status"}
+    ])(
+      "When status is '$status' and business status is '$businessStatus', should return unsupported issue.",
+      ({status, businessStatus}) => {
+        const task = {status, businessStatus: {coding: [{code: businessStatus}]}}
+        const actual = statuses(task as Task)
+        const expected = `Unsupported Task.businessStatus '${businessStatus}'.`
+        expect(actual).toEqual(expected)
+      }
+    )
+  })
 })
 
 describe("Unit tests for validation of resourceType", () => {
@@ -287,7 +315,8 @@ describe("Unit tests for validation of transaction bundle", () => {
       type: "transaction",
       expected: true
     }
-  ])("When resourceType is $resourceType and type is $type, should return $expected.",
+  ])(
+    "When resourceType is $resourceType and type is $type, should return $expected.",
     async ({resourceType, type, expected}) => {
       const body = {resourceType: resourceType, type: type}
 
@@ -299,15 +328,13 @@ describe("Unit tests for validation of transaction bundle", () => {
 })
 
 describe("Unit tests for validation of businessStatus", () => {
-  it.each(BUSINESS_STATUSES)("When businessStatus is valid, should return undefined.",
-    async (status) => {
-      const task = {businessStatus: {coding: [{code: status}]}}
+  it.each(BUSINESS_STATUSES)("When businessStatus is valid, should return undefined.", async (status) => {
+    const task = {businessStatus: {coding: [{code: status}]}}
 
-      const actual = businessStatus(task as Task)
+    const actual = businessStatus(task as Task)
 
-      expect(actual).toEqual(undefined)
-    }
-  )
+    expect(actual).toEqual(undefined)
+  })
 
   it("When businessStatus is invalid, should return expected message.", async () => {
     const task = {businessStatus: {coding: [{code: "Invalid"}]}}