From 4b6152896502266a9d821bc27c41ac1989ea6d5b Mon Sep 17 00:00:00 2001
From: Donald Kibet <chelashawdonald@yahoo.com>
Date: Wed, 16 Oct 2024 13:57:30 +0300
Subject: [PATCH] (feat) O3-4087: Enable input for set-based lab tests on lab
 results form and handle partial set results (#2062)

* (feat) O3-4087 : enable input for set-based lab tests on lab results form and handle partial set results

* code reviews changes

* additional code review changes
---
 .../lab-results-form.component.tsx            |  76 ++---
 .../src/lab-results/lab-results-form.test.tsx | 281 +++++++++++++++++-
 .../src/lab-results/lab-results.resource.ts   |  69 +++++
 3 files changed, 365 insertions(+), 61 deletions(-)

diff --git a/packages/esm-patient-orders-app/src/lab-results/lab-results-form.component.tsx b/packages/esm-patient-orders-app/src/lab-results/lab-results-form.component.tsx
index c663316da..1745cfed1 100644
--- a/packages/esm-patient-orders-app/src/lab-results/lab-results-form.component.tsx
+++ b/packages/esm-patient-orders-app/src/lab-results/lab-results-form.component.tsx
@@ -5,7 +5,13 @@ import { mutate } from 'swr';
 import { Button, ButtonSet, Form, InlineLoading, InlineNotification, Stack } from '@carbon/react';
 import { type DefaultPatientWorkspaceProps, type Order } from '@openmrs/esm-patient-common-lib';
 import { restBaseUrl, showSnackbar, useAbortController, useLayoutType } from '@openmrs/esm-framework';
-import { useOrderConceptByUuid, updateOrderResult, useLabEncounter, useObservation } from './lab-results.resource';
+import {
+  useOrderConceptByUuid,
+  updateOrderResult,
+  useLabEncounter,
+  useObservation,
+  createObservationPayload,
+} from './lab-results.resource';
 import ResultFormField from './lab-results-form-field.component';
 import styles from './lab-results-form.scss';
 import { useLabResultsFormSchema } from './useLabResultsFormSchema';
@@ -37,9 +43,8 @@ const LabResultsForm: React.FC<LabResultsFormProps> = ({
   const {
     control,
     formState: { errors, isDirty, isSubmitting },
-    getValues,
     handleSubmit,
-  } = useForm<{ testResult: any }>({
+  } = useForm<{ testResult: Record<string, unknown> }>({
     defaultValues: {},
     resolver: zodResolver(schema),
     mode: 'all',
@@ -94,66 +99,16 @@ const LabResultsForm: React.FC<LabResultsFormProps> = ({
     );
   }
 
-  const saveLabResults = async (formData) => {
-    const formValues = getValues();
-
+  const saveLabResults = async (formValues: Record<string, unknown>) => {
     const isEmptyForm = Object.values(formValues).every(
       (value) => value === '' || value === null || value === undefined,
     );
-
     if (isEmptyForm) {
       setShowEmptyFormErrorNotification(true);
       return;
     }
-
-    let obsValue = [];
-
-    if (concept.set && concept.setMembers.length > 0) {
-      let groupMembers = [];
-      concept.setMembers.forEach((member) => {
-        let value;
-        if (member.datatype.display === 'Numeric' || member.datatype.display === 'Text') {
-          value = getValues()[`${member.uuid}`];
-        } else if (member.datatype.display === 'Coded') {
-          value = {
-            uuid: getValues()[`${member.uuid}`],
-          };
-        }
-        const groupMember = {
-          concept: { uuid: member.uuid },
-          value: value,
-          status: 'FINAL',
-          order: { uuid: order.uuid },
-        };
-        groupMembers.push(groupMember);
-      });
-
-      obsValue.push({
-        concept: { uuid: order.concept.uuid },
-        status: 'FINAL',
-        order: { uuid: order.uuid },
-        groupMembers: groupMembers,
-      });
-    } else if (!concept.set && concept.setMembers.length === 0) {
-      let value;
-      if (concept.datatype.display === 'Numeric' || concept.datatype.display === 'Text') {
-        value = getValues()[`${concept.uuid}`];
-      } else if (concept.datatype.display === 'Coded') {
-        value = {
-          uuid: getValues()[`${concept.uuid}`],
-        };
-      }
-
-      obsValue.push({
-        concept: { uuid: order.concept.uuid },
-        status: 'FINAL',
-        order: { uuid: order.uuid },
-        value: value,
-      });
-    }
-
-    const obsPayload = { obs: obsValue };
-
+    // Set the observation status to 'FINAL' as we're not capturing it in the form
+    const obsPayload = createObservationPayload(concept, order, formValues, 'FINAL');
     const orderDiscontinuationPayload = {
       previousOrder: order.uuid,
       type: 'testorder',
@@ -164,7 +119,6 @@ const LabResultsForm: React.FC<LabResultsFormProps> = ({
       concept: order.concept.uuid,
       orderer: order.orderer,
     };
-
     const resultsStatusPayload = {
       fulfillerStatus: 'COMPLETED',
       fulfillerComment: 'Test Results Entered',
@@ -179,7 +133,6 @@ const LabResultsForm: React.FC<LabResultsFormProps> = ({
         orderDiscontinuationPayload,
         abortController,
       );
-
       closeWorkspaceWithSavedChanges();
       mutateLabOrders();
       mutateOrderData();
@@ -227,7 +180,12 @@ const LabResultsForm: React.FC<LabResultsFormProps> = ({
         <Button className={styles.button} kind="secondary" disabled={isSubmitting} onClick={closeWorkspace}>
           {t('discard', 'Discard')}
         </Button>
-        <Button className={styles.button} kind="primary" disabled={isSubmitting} type="submit">
+        <Button
+          className={styles.button}
+          kind="primary"
+          disabled={isSubmitting || Object.keys(errors).length > 0}
+          type="submit"
+        >
           {isSubmitting ? (
             <InlineLoading description={t('saving', 'Saving') + '...'} />
           ) : (
diff --git a/packages/esm-patient-orders-app/src/lab-results/lab-results-form.test.tsx b/packages/esm-patient-orders-app/src/lab-results/lab-results-form.test.tsx
index 94c1f5332..c2c827e11 100644
--- a/packages/esm-patient-orders-app/src/lab-results/lab-results-form.test.tsx
+++ b/packages/esm-patient-orders-app/src/lab-results/lab-results-form.test.tsx
@@ -1,7 +1,14 @@
 import React from 'react';
 import { render, screen, waitFor } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
-import { useOrderConceptByUuid, useLabEncounter, useObservation, type LabOrderConcept } from './lab-results.resource';
+import {
+  useOrderConceptByUuid,
+  useLabEncounter,
+  useObservation,
+  type LabOrderConcept,
+  updateOrderResult,
+  type Datatype,
+} from './lab-results.resource';
 import LabResultsForm from './lab-results-form.component';
 import { type Order } from '@openmrs/esm-patient-common-lib';
 import { type Encounter } from '../types/encounter';
@@ -11,6 +18,7 @@ const mockUseLabEncounter = jest.mocked(useLabEncounter);
 const mockUseObservation = jest.mocked(useObservation);
 
 jest.mock('./lab-results.resource', () => ({
+  ...jest.requireActual('./lab-results.resource'),
   useOrderConceptByUuid: jest.fn(),
   useLabEncounter: jest.fn(),
   useObservation: jest.fn(),
@@ -24,6 +32,7 @@ const mockOrder = {
   patient: { uuid: 'patient-uuid' },
   orderNumber: 'ORD-1',
   careSetting: { uuid: 'care-setting-uuid' },
+  orderer: { uuid: 'orderer-uuid' },
 };
 
 const testProps = {
@@ -206,7 +215,7 @@ describe('LabResultsForm', () => {
     });
   });
 
-  test('validate numeric input where concept is a panel', async () => {
+  test('validate numeric input where concept is a set', async () => {
     const user = userEvent.setup();
     mockUseOrderConceptByUuid.mockReturnValue({
       concept: {
@@ -279,4 +288,272 @@ describe('LabResultsForm', () => {
     await user.type(setMember2Input, '4');
     expect(await screen.findByText('Set Member 2 must be between 5 and 30')).toBeInTheDocument();
   });
+
+  test('lab results form submits the correct lab result payload when the concept is not a set', async () => {
+    const user = userEvent.setup();
+    mockUseOrderConceptByUuid.mockReturnValue({
+      concept: {
+        uuid: 'concept-uuid',
+        display: 'Test Concept',
+        setMembers: [],
+        datatype: { display: 'Text', hl7Abbreviation: 'ST' } as Datatype,
+        hiAbsolute: 100,
+        lowAbsolute: 0,
+        lowCritical: null,
+        lowNormal: null,
+        hiCritical: null,
+        hiNormal: null,
+        units: 'mg/dL',
+      } as LabOrderConcept,
+      isLoading: false,
+      error: null,
+      isValidating: false,
+      mutate: jest.fn(),
+    });
+
+    render(<LabResultsForm {...testProps} />);
+    const input = await screen.findByRole('textbox', { name: /Test Concept/i });
+    await user.type(input, '100');
+    const submitButton = screen.getByRole('button', { name: 'Save and close' });
+    await user.click(submitButton);
+
+    expect(updateOrderResult).toHaveBeenCalledWith(
+      'order-uuid',
+      'encounter-uuid',
+      { obs: [{ concept: { uuid: 'concept-uuid' }, order: { uuid: 'order-uuid' }, status: 'FINAL', value: '100' }] },
+      { fulfillerComment: 'Test Results Entered', fulfillerStatus: 'COMPLETED' },
+      {
+        action: 'DISCONTINUE',
+        careSetting: 'care-setting-uuid',
+        concept: 'concept-uuid',
+        encounter: 'encounter-uuid',
+        orderer: mockOrder.orderer,
+        patient: 'patient-uuid',
+        previousOrder: 'order-uuid',
+        type: 'testorder',
+      },
+      expect.anything(),
+    );
+  });
+
+  test('lab results forms submits correct payload when the concept is a set and one set member is keyed', async () => {
+    const user = userEvent.setup();
+    mockUseOrderConceptByUuid.mockReturnValue({
+      concept: {
+        uuid: 'concept-uuid',
+        display: 'Test Concept',
+        set: true,
+        setMembers: [
+          {
+            uuid: 'set-member-uuid-1',
+            display: 'Set Member 1',
+            concept: { uuid: 'concept-uuid-1', display: 'Concept 1' },
+            datatype: { display: 'Numeric', hl7Abbreviation: 'NM' } as Datatype,
+            hiAbsolute: 100,
+            lowAbsolute: 0,
+            lowCritical: null,
+            lowNormal: null,
+            hiCritical: null,
+            hiNormal: null,
+            units: 'mg/dL',
+          },
+          {
+            uuid: 'set-member-uuid-2',
+            display: 'Set Member 2',
+            concept: { uuid: 'concept-uuid-2', display: 'Concept 2' },
+            datatype: { display: 'Numeric', hl7Abbreviation: 'NM' } as Datatype,
+            hiAbsolute: 80,
+            lowAbsolute: 0,
+            lowCritical: null,
+            lowNormal: null,
+            hiCritical: null,
+            hiNormal: null,
+            units: 'mmol/L',
+          },
+        ],
+        datatype: { display: 'Numeric', hl7Abbreviation: 'NM' },
+        hiAbsolute: 100,
+        lowAbsolute: 0,
+        lowCritical: null,
+        lowNormal: null,
+        hiCritical: null,
+        hiNormal: null,
+        units: 'mg/dL',
+      } as unknown as LabOrderConcept,
+      isLoading: false,
+      error: null,
+      isValidating: false,
+      mutate: jest.fn(),
+    });
+
+    render(<LabResultsForm {...testProps} />);
+    const concept1Input = await screen.findByLabelText('Set Member 1 (0 - 100 mg/dL)');
+    await user.type(concept1Input, '100');
+
+    const submitButton = screen.getByRole('button', { name: 'Save and close' });
+    await user.click(submitButton);
+
+    // Expect the observation payload to include only the set member that was keyed
+    expect(updateOrderResult).toHaveBeenCalledWith(
+      'order-uuid',
+      'encounter-uuid',
+      {
+        obs: [
+          {
+            concept: {
+              uuid: 'concept-uuid',
+            },
+            status: 'FINAL',
+            order: {
+              uuid: 'order-uuid',
+            },
+            groupMembers: [
+              {
+                concept: {
+                  uuid: 'set-member-uuid-1',
+                },
+                value: 100,
+                status: 'FINAL',
+                order: {
+                  uuid: 'order-uuid',
+                },
+              },
+            ],
+          },
+        ],
+      },
+      {
+        fulfillerStatus: 'COMPLETED',
+        fulfillerComment: 'Test Results Entered',
+      },
+      {
+        previousOrder: 'order-uuid',
+        type: 'testorder',
+        action: 'DISCONTINUE',
+        careSetting: 'care-setting-uuid',
+        encounter: 'encounter-uuid',
+        patient: 'patient-uuid',
+        concept: 'concept-uuid',
+        orderer: { uuid: 'orderer-uuid' },
+      },
+      expect.anything(),
+    );
+  });
+
+  test('lab results form submits correct payload when the concept is a set and both set members are keyed', async () => {
+    const user = userEvent.setup();
+    mockUseOrderConceptByUuid.mockReturnValue({
+      concept: {
+        uuid: 'concept-uuid',
+        display: 'Test Concept',
+        set: true,
+        setMembers: [
+          {
+            uuid: 'set-member-uuid-1',
+            display: 'Set Member 1',
+            concept: { uuid: 'concept-uuid-1', display: 'Concept 1' },
+            datatype: { display: 'Numeric', hl7Abbreviation: 'NM' },
+            hiAbsolute: 100,
+            lowAbsolute: 0,
+            lowCritical: null,
+            lowNormal: null,
+            hiCritical: null,
+            hiNormal: null,
+            units: 'mg/dL',
+          },
+          {
+            uuid: 'set-member-uuid-2',
+            display: 'Set Member 2',
+            concept: { uuid: 'concept-uuid-2', display: 'Concept 2' },
+            datatype: { display: 'Numeric', hl7Abbreviation: 'NM' },
+            hiAbsolute: 80,
+            lowAbsolute: 0,
+            lowCritical: null,
+            lowNormal: null,
+            hiCritical: null,
+            hiNormal: null,
+            units: 'mmol/L',
+          },
+        ],
+        datatype: { display: 'Numeric' },
+        hiAbsolute: 100,
+        lowAbsolute: 0,
+        lowCritical: null,
+        lowNormal: null,
+        hiCritical: null,
+        hiNormal: null,
+        units: 'mg/dL',
+      } as unknown as LabOrderConcept,
+      isLoading: false,
+      error: null,
+      isValidating: false,
+      mutate: jest.fn(),
+    });
+
+    render(<LabResultsForm {...testProps} />);
+    const concept1Input = await screen.findByLabelText('Set Member 1 (0 - 100 mg/dL)');
+    await user.type(concept1Input, '100');
+
+    const concept2Input = await screen.findByLabelText('Set Member 2 (0 - 80 mmol/L)');
+    await user.type(concept2Input, '60');
+
+    const submitButton = screen.getByRole('button', { name: 'Save and close' });
+    await user.click(submitButton);
+
+    // Expect the observation payload to include both set members with their respective values
+    expect(updateOrderResult).toHaveBeenCalledWith(
+      'order-uuid',
+      'encounter-uuid',
+      {
+        obs: [
+          {
+            concept: {
+              uuid: 'concept-uuid',
+            },
+            status: 'FINAL',
+            order: {
+              uuid: 'order-uuid',
+            },
+            groupMembers: [
+              {
+                concept: {
+                  uuid: 'set-member-uuid-1',
+                },
+                value: 100,
+                status: 'FINAL',
+                order: {
+                  uuid: 'order-uuid',
+                },
+              },
+              {
+                concept: {
+                  uuid: 'set-member-uuid-2',
+                },
+                value: 60,
+                status: 'FINAL',
+                order: {
+                  uuid: 'order-uuid',
+                },
+              },
+            ],
+          },
+        ],
+      },
+      {
+        fulfillerStatus: 'COMPLETED',
+        fulfillerComment: 'Test Results Entered',
+      },
+      {
+        previousOrder: 'order-uuid',
+        type: 'testorder',
+        action: 'DISCONTINUE',
+        careSetting: 'care-setting-uuid',
+        encounter: 'encounter-uuid',
+        patient: 'patient-uuid',
+        concept: 'concept-uuid',
+        orderer: { uuid: 'orderer-uuid' },
+      },
+      expect.anything(),
+    );
+  });
 });
diff --git a/packages/esm-patient-orders-app/src/lab-results/lab-results.resource.ts b/packages/esm-patient-orders-app/src/lab-results/lab-results.resource.ts
index 3009c43b8..f42209bc1 100644
--- a/packages/esm-patient-orders-app/src/lab-results/lab-results.resource.ts
+++ b/packages/esm-patient-orders-app/src/lab-results/lab-results.resource.ts
@@ -2,6 +2,7 @@ import useSWR from 'swr';
 import { type OpenmrsResource, openmrsFetch, restBaseUrl, type FetchResponse } from '@openmrs/esm-framework';
 import { type Observation, type Encounter } from '../types/encounter';
 import { type OrderDiscontinuationPayload } from '../types/order';
+import { type Order } from '@openmrs/esm-patient-common-lib';
 
 const labEncounterRepresentation =
   'custom:(uuid,encounterDatetime,encounterType,location:(uuid,name),' +
@@ -158,3 +159,71 @@ export async function updateOrderResult(
   }
   throw new Error('Failed to update order');
 }
+
+export function createObservationPayload(
+  concept: LabOrderConcept,
+  order: Order,
+  values: Record<string, unknown>,
+  status: string,
+) {
+  if (concept.set && concept.setMembers.length > 0) {
+    const groupMembers = concept.setMembers
+      .map((member) => createGroupMember(member, order, values, status))
+      .filter((member) => member !== null && member.value !== null && member.value !== undefined);
+
+    if (groupMembers.length === 0) {
+      return { obs: [] };
+    }
+
+    return { obs: [createObservation(order, groupMembers, null, status)] };
+  } else {
+    const value = getValue(concept, values);
+    if (value === null || value === undefined) {
+      return { obs: [] };
+    }
+    return { obs: [createObservation(order, null, value, status)] };
+  }
+}
+
+function createGroupMember(member: LabOrderConcept, order: Order, values: Record<string, unknown>, status: string) {
+  const value = getValue(member, values);
+  if (value === null || value === undefined) {
+    return null;
+  }
+  return {
+    concept: { uuid: member.uuid },
+    value: value,
+    status: status,
+    order: { uuid: order.uuid },
+  };
+}
+
+function createObservation(order: Order, groupMembers = null, value = null, status: string) {
+  return {
+    concept: { uuid: order.concept.uuid },
+    status: status,
+    order: { uuid: order.uuid },
+    ...(groupMembers && groupMembers.length > 0 && { groupMembers }),
+    ...(value !== null && value !== undefined && { value }),
+  };
+}
+
+function getValue(concept: LabOrderConcept, values: Record<string, unknown>) {
+  const { datatype, uuid } = concept;
+  const value = values[uuid];
+
+  if (value === null || value === undefined) {
+    return null;
+  }
+
+  // hl7Abbreviation is NM for Numeric and ST for Text
+  if (['NM', 'ST'].includes(datatype.hl7Abbreviation)) {
+    return value;
+  }
+  // hl7Abbreviation is CWE for Coded with exceptions datatype
+  if (datatype.hl7Abbreviation === 'CWE') {
+    return { uuid: value };
+  }
+
+  return null;
+}