New: [AEA-4047] - Set statuses to temporarily unavailable if nppts fa…

…ils (#1024) ## Summary - Routine Change ### Details No longer use catch all error for nppts call. Always progress to enrich prescriptions. Update items expecting status updates with temporary message. --------- Co-authored-by: MatthewPopat-NHS <[email protected]>
NHSDigital · Jul 11, 2024 · de52064 · de52064
1 parent c98bcf4
commit de52064
Show file tree

Hide file tree

Showing 12 changed files with 359 additions and 75 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -52,8 +52,7 @@
         "python.analysis.extraPaths": [],
         "python.testing.unittestEnabled": false,
         "python.testing.pytestEnabled": true,
-        "python.linting.pylintEnabled": false,
-        "python.linting.flake8Enabled": true,
+        "flake8.enabled": true,
         "python.linting.enabled": true, // required to format on save
         "editor.defaultFormatter": "rvest.vs-code-prettier-eslint",
         "editor.formatOnPaste": false, // required

diff --git a/.vscode/prescriptionsforpatients.code-workspace b/.vscode/prescriptionsforpatients.code-workspace
@@ -77,6 +77,7 @@
           "nhsdlogin",
           "nhslogin",
           "NOSONAR",
+          "nppt",
           "OIDC",
           "onboarded",
           "Organisation",

diff --git a/SAMtemplates/functions/main.yaml b/SAMtemplates/functions/main.yaml
@@ -115,6 +115,7 @@ Resources:
       Environment:
         Variables:
           LOG_LEVEL: !Ref LogLevel
+          EXPECT_STATUS_UPDATES: !Ref ToggleGetStatusUpdates
     Metadata:
       BuildMethod: esbuild
       BuildProperties:

diff --git a/SAMtemplates/state_machines/GetMyPrescriptionsStateMachine.asl.json b/SAMtemplates/state_machines/GetMyPrescriptionsStateMachine.asl.json
@@ -60,7 +60,7 @@
         "FunctionName": "${GetStatusUpdatesFunctionArn}"
       },
       "InputPath": "$.statusUpdateData",
-      "Next": "Get Status Updates Result",
+      "Next": "Enrich Prescriptions",
       "ResultSelector": {
         "Payload.$": "$.Payload"
       },
@@ -70,23 +70,11 @@
           "ErrorEquals": [
             "States.ALL"
           ],
-          "Next": "Catch All Error"
+          "Next": "Enrich Prescriptions",
+          "ResultPath": "$.error"
         }
       ]
     },
-    "Get Status Updates Result": {
-      "Type": "Choice",
-      "Choices": [
-        {
-          "Not": {
-            "Variable": "$.StatusUpdates.Payload.isSuccess",
-            "BooleanEquals": true
-          },
-          "Next": "Catch All Error"
-        }
-      ],
-      "Default": "Enrich Prescriptions"
-    },
     "Enrich Prescriptions": {
       "Type": "Task",
       "Resource": "arn:aws:states:::lambda:invoke",

diff --git a/packages/enrichPrescriptions/src/enrichPrescriptions.ts b/packages/enrichPrescriptions/src/enrichPrescriptions.ts
@@ -4,14 +4,22 @@ import {LogLevel} from "@aws-lambda-powertools/logger/types"
 import middy from "@middy/core"
 import inputOutputLogger from "@middy/input-output-logger"
 import {Bundle} from "fhir/r4"
-import {StatusUpdates, applyStatusUpdates} from "./statusUpdates"
+import {
+  StatusUpdateRequest,
+  StatusUpdates,
+  UpdatesScenario,
+  applyStatusUpdates,
+  applyTemporaryStatusUpdates,
+  getUpdatesScenario
+} from "./statusUpdates"
 import {TraceIDs, lambdaResponse} from "./responses"
 
 export const LOG_LEVEL = process.env.LOG_LEVEL as LogLevel
 export const logger = new Logger({serviceName: "enrichPrescriptions", logLevel: LOG_LEVEL})
 
 export type EnrichPrescriptionsEvent = {
-  fhir: Bundle,
+  fhir: Bundle
+  statusUpdateData: StatusUpdateRequest
   StatusUpdates?: {Payload: StatusUpdates}
   traceIDs: TraceIDs
 }
@@ -28,12 +36,23 @@ export async function lambdaHandler(event: EnrichPrescriptionsEvent) {
 
   const searchsetBundle = event.fhir
   const statusUpdates = event.StatusUpdates?.Payload
+  const updatesScenario = getUpdatesScenario(statusUpdates)
 
-  if (statusUpdates) {
-    logger.info("Applying status updates.")
-    applyStatusUpdates(searchsetBundle, statusUpdates)
-  } else {
-    logger.info("No status updates to apply.")
+  switch (updatesScenario) {
+    case UpdatesScenario.Present: {
+      logger.info("Applying status updates.")
+      applyStatusUpdates(searchsetBundle, statusUpdates!)
+      break
+    }
+    case UpdatesScenario.ExpectedButAbsent: {
+      logger.info("Call to get status updates was unsuccessful. Applying temporary status updates.")
+      const statusUpdateRequest = event.statusUpdateData!
+      applyTemporaryStatusUpdates(searchsetBundle, statusUpdateRequest)
+      break
+    }
+    default: {
+      logger.info("Get Status Updates is toggled-off. No status updates to apply.")
+    }
   }
 
   return lambdaResponse(200, searchsetBundle, event.traceIDs)

diff --git a/packages/enrichPrescriptions/src/fhirUtils.ts b/packages/enrichPrescriptions/src/fhirUtils.ts
@@ -2,7 +2,8 @@ import {
   Bundle,
   BundleEntry,
   FhirResource,
-  MedicationRequest
+  MedicationRequest,
+  Organization
 } from "fhir/r4"
 
 export type Entry = BundleEntry<FhirResource>
@@ -32,8 +33,23 @@ export function isolatePrescriptions(searchsetBundle: Bundle): Array<Bundle> {
 }
 
 export function isolateMedicationRequests(prescription: Bundle): Array<MedicationRequest> | undefined {
-  return prescription.entry?.filter(entry => entry?.resource?.resourceType === "MedicationRequest")
-    .map(entry => entry?.resource as MedicationRequest)
+  return prescription.entry
+    ?.filter((entry) => entry?.resource?.resourceType === "MedicationRequest")
+    .map((entry) => entry?.resource as MedicationRequest)
+}
+
+export function isolatePerformerReference(medicationRequests: Array<MedicationRequest>): string | undefined {
+  for (const medicationRequest of medicationRequests) {
+    const reference = medicationRequest.dispenseRequest?.performer?.reference
+    if (reference !== undefined) {
+      return reference
+    }
+  }
+}
+
+export function isolatePerformerOrganisation(reference: string, prescription: Bundle): Organization {
+  const filter = (entry: Entry) => entry.fullUrl! === reference
+  return filterAndTypeBundleEntries<Organization>(prescription, filter)[0]
 }
 
 function filterAndTypeBundleEntries<T>(bundle: Bundle, filter: (entry: Entry) => boolean): Array<T> {

diff --git a/packages/enrichPrescriptions/src/statusUpdates.ts b/packages/enrichPrescriptions/src/statusUpdates.ts
@@ -1,19 +1,30 @@
 import {Bundle, Extension, MedicationRequest} from "fhir/r4"
 import moment, {Moment} from "moment"
-import {isolateMedicationRequests, isolatePrescriptions} from "./fhirUtils"
+import {
+  isolateMedicationRequests,
+  isolatePerformerOrganisation,
+  isolatePerformerReference,
+  isolatePrescriptions
+} from "./fhirUtils"
 import {logger} from "./enrichPrescriptions"
 
 export const EXTENSION_URL = "https://fhir.nhs.uk/StructureDefinition/Extension-DM-PrescriptionStatusHistory"
-export const DEFAULT_EXTENSION_STATUS = "With Pharmacy"
-export const NOT_ONBOARDED_DEFAULT_EXTENSION_STATUS = "With Pharmacy but Tracking not Supported"
 export const VALUE_CODING_SYSTEM = "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt"
 export const ONE_WEEK_IN_MS = 604800000
 
+export const DEFAULT_EXTENSION_STATUS = "With Pharmacy"
+export const NOT_ONBOARDED_DEFAULT_EXTENSION_STATUS = "With Pharmacy but Tracking not Supported"
+export const TEMPORARILY_UNAVAILABLE_STATUS = "Tracking Temporarily Unavailable"
+export const APPROVED_STATUS = "Prescriber Approved"
+export const CANCELLED_STATUS = "Prescriber Cancelled"
+
+export const expectStatusUpdates = () => process.env.EXPECT_STATUS_UPDATES === "true"
+
 type MedicationRequestStatus = "completed" | "active"
 
 type UpdateItem = {
   isTerminalState: boolean
-  itemId: string
+  itemId?: string
   lastUpdateDateTime: string
   latestStatus: string
 }
@@ -30,12 +41,21 @@ export type StatusUpdates = {
   schemaVersion: number
 }
 
+export type Prescription = {
+  odsCode: string
+  prescriptionID: string
+}
+
+export type StatusUpdateRequest = {
+  schemaVersion: number
+  prescriptions: Array<Prescription>
+}
+
 function defaultUpdate(onboarded: boolean = true): UpdateItem {
   return {
     isTerminalState: false,
     latestStatus: onboarded ? DEFAULT_EXTENSION_STATUS : NOT_ONBOARDED_DEFAULT_EXTENSION_STATUS,
-    lastUpdateDateTime: moment().utc().toISOString(),
-    itemId: ""
+    lastUpdateDateTime: moment().utc().toISOString()
   }
 }
 
@@ -56,7 +76,7 @@ function updateMedicationRequest(medicationRequest: MedicationRequest, updateIte
   const relevantExtension = medicationRequest.extension?.find((ext) => ext.url === EXTENSION_URL)
   const statusCoding = relevantExtension?.extension?.find((innerExt) => innerExt.url === "status")?.valueCoding?.code
 
-  if (statusCoding && (statusCoding === "Prescriber Approved" || statusCoding === "Prescriber Cancelled")) {
+  if (statusCoding && (statusCoding === APPROVED_STATUS || statusCoding === CANCELLED_STATUS)) {
     logger.info(
       `Status update for prescription ${updateItem.itemId} has been skipped because the current status is already ` +
         `${statusCoding}.`
@@ -146,10 +166,8 @@ export function applyStatusUpdates(searchsetBundle: Bundle, statusUpdates: Statu
           // set status as Prescriber Approved
           const update: UpdateItem = {
             isTerminalState: false,
-            itemId: "",
-            //Placeholder now datetime
             lastUpdateDateTime: moment().utc().toISOString(),
-            latestStatus: "Prescriber Approved"
+            latestStatus: APPROVED_STATUS
           }
           updateMedicationRequest(medicationRequest, update)
           return
@@ -215,3 +233,44 @@ function getStatus(statusExtension: Extension): string | undefined {
     .map((coding) => coding?.code)
     .pop()
 }
+
+export enum UpdatesScenario {
+  Present,
+  ExpectedButAbsent,
+  NotExpected
+}
+
+export function getUpdatesScenario(statusUpdates: StatusUpdates | undefined): UpdatesScenario {
+  if (expectStatusUpdates() && statusUpdates) {
+    return statusUpdates.isSuccess ? UpdatesScenario.Present : UpdatesScenario.ExpectedButAbsent
+  } else if (expectStatusUpdates() && !statusUpdates) {
+    return UpdatesScenario.ExpectedButAbsent
+  }
+  return UpdatesScenario.NotExpected
+}
+
+export function applyTemporaryStatusUpdates(searchsetBundle: Bundle, statusUpdateRequest: StatusUpdateRequest) {
+  const update: UpdateItem = {
+    isTerminalState: false,
+    lastUpdateDateTime: moment().utc().toISOString(),
+    latestStatus: TEMPORARILY_UNAVAILABLE_STATUS
+  }
+  isolatePrescriptions(searchsetBundle).forEach((prescription) => {
+    const medicationRequests = isolateMedicationRequests(prescription)
+    const prescriptionID = medicationRequests![0].groupIdentifier!.value!.toUpperCase()
+
+    const performerReference = isolatePerformerReference(medicationRequests!)
+    if (performerReference) {
+      const performer = isolatePerformerOrganisation(performerReference, prescription)
+      const odsCode = performer.identifier![0].value!.toUpperCase()
+
+      const updates = statusUpdateRequest.prescriptions.filter(
+        (data) => data.prescriptionID.toUpperCase() === prescriptionID && data.odsCode.toUpperCase() === odsCode
+      )
+      if (updates.length > 0) {
+        logger.info(`Updates expected for medication requests in prescription ${prescriptionID}. Applying temporary.`)
+        medicationRequests?.forEach((medicationRequest) => updateMedicationRequest(medicationRequest, update))
+      }
+    }
+  })
+}
diff --git a/packages/enrichPrescriptions/tests/testHandler.test.ts b/packages/enrichPrescriptions/tests/testHandler.test.ts
@@ -9,6 +9,7 @@ import {
 import {
   SYSTEM_DATETIME,
   defaultExtension,
+  getStatusUpdatesFailedEventAndResponse,
   noUpdateDataEventAndResponse,
   richEventAndResponse,
   simpleEventAndResponse
@@ -19,6 +20,7 @@ import {lambdaHandler} from "../src/enrichPrescriptions"
 describe("Unit tests for handler", function () {
   beforeEach(() => {
     jest.useFakeTimers().setSystemTime(SYSTEM_DATETIME)
+    process.env.EXPECT_STATUS_UPDATES = "true"
   })
 
   it("when event contains a bundle with one prescription, one MedicationRequest and status updates, updates are applied", async () => {
@@ -51,10 +53,26 @@ describe("Unit tests for handler", function () {
     expect(actualResponse).toEqual(expectedResponse)
   })
 
-  it("when no status update data (call to GetStatusUpdates toggled-off), no updates are applied", async () => {
+  it("when no status update data (GetStatusUpdates toggled-off), no updates are applied", async () => {
+    process.env.EXPECT_STATUS_UPDATES = "false"
     const {event, expectedResponse} = noUpdateDataEventAndResponse()
     const actualResponse = await lambdaHandler(event)
 
     expect(actualResponse).toEqual(expectedResponse)
   })
+
+  it("when status updates are expected but unsuccessful (GetStatusUpdates fails at code level), temporary updates are applied", async () => {
+    const {event, expectedResponse} = getStatusUpdatesFailedEventAndResponse()
+    const actualResponse = await lambdaHandler(event)
+
+    expect(actualResponse).toEqual(expectedResponse)
+  })
+
+  it("when status updates are expected but not present (GetStatusUpdates fails at state machine level), temporary updates are applied", async () => {
+    const {event, expectedResponse} = getStatusUpdatesFailedEventAndResponse()
+    delete event.StatusUpdates
+    const actualResponse = await lambdaHandler(event)
+
+    expect(actualResponse).toEqual(expectedResponse)
+  })
 })