@openmrs/esm-laboratory-app 1.2.1-pre.734 → 1.2.1-pre.740

package/src/components/orders-table/orders-data-table.test.tsx

@@ -0,0 +1,215 @@
+import React from 'react';
+import { render, screen, within } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import OrdersDataTable from './orders-data-table.component';
+import { useConfig, getDefaultsFromConfigSchema, type Patient, Person } from '@openmrs/esm-framework';
+import { configSchema, type Config } from '../../config-schema';
+import { useLabOrders, type UseLabOrdersParams } from '../../laboratory-resource';
+import { type Order } from '@openmrs/esm-patient-common-lib';
+
+jest.mock('../../laboratory-resource', () => ({
+  useLabOrders: jest.fn(),
+}));
+
+const mockUseConfig = jest.mocked(useConfig<Config>);
+const mockUseLabOrders = jest.mocked(useLabOrders);
+
+function mockUseLabOrdersImplementation(props: Partial<UseLabOrdersParams>) {
+  const mockPatient1: Partial<Patient> = {
+    uuid: 'patient-uuid-1',
+    display: 'PAT-001 - Pete Seeger',
+    identifiers: props.includePatientId
+      ? [
+          {
+            uuid: 'identifier-uuid-1',
+            identifier: 'PAT-001',
+            preferred: true,
+            voided: false,
+            identifierType: {
+              uuid: 'identifier-type-uuid-1',
+            },
+          },
+          {
+            uuid: 'identifier-uuid-2',
+            identifier: 'BAD-ID-NOT-PREFERRED',
+            preferred: false,
+            voided: false,
+            identifierType: {
+              uuid: 'identifier-type-uuid-1',
+            },
+          },
+        ]
+      : undefined,
+    person: {
+      uuid: 'person-uuid-1',
+      display: 'Pete Seeger',
+      age: 70,
+      gender: 'M',
+    },
+  };
+  const mockPatient2: Partial<Patient> = {
+    uuid: 'patient-uuid-2',
+    display: 'PAT-002 - Bob Dylan',
+    identifiers: props.includePatientId
+      ? [
+          {
+            uuid: 'identifier-uuid-3',
+            identifier: 'BAD-ID-WRONG-TYPE',
+            preferred: true,
+            voided: false,
+            identifierType: {
+              uuid: '05a29f94-c0ed-11e2-94be-8c13b969e334',
+            },
+          },
+          {
+            uuid: 'identifier-uuid-4',
+            identifier: 'PAT-002',
+            preferred: true,
+            voided: false,
+            identifierType: {
+              uuid: 'identifier-type-uuid-1',
+            },
+          },
+        ]
+      : undefined,
+    person: {
+      uuid: 'person-uuid-2',
+      display: 'Bob Dylan',
+      age: 60,
+      gender: 'M',
+    },
+  };
+
+  const mockOrderer = {
+    uuid: 'orderer-uuid-1',
+    display: 'Dr. John Doe',
+    person: {
+      display: 'Dr. John Doe',
+    },
+  };
+
+  const labOrders = [
+    {
+      uuid: 'order-uuid-1',
+      orderNumber: 'ORD-001',
+      patient: mockPatient1 as Patient,
+      dateActivated: '2021-01-01',
+      fulfillerStatus: 'RECEIVED',
+      urgency: 'ROUTINE',
+      orderer: mockOrderer,
+      instructions: 'Inspect banjo & check tuning',
+      fulfillerComment: null,
+      display: 'Banjo Inspection',
+    },
+    {
+      uuid: 'order-uuid-2',
+      orderNumber: 'ORD-002',
+      patient: mockPatient1 as Patient,
+      dateActivated: '2021-01-01',
+      fulfillerStatus: 'RECEIVED',
+      urgency: 'ROUTINE',
+      orderer: mockOrderer,
+      instructions: 'Give it a strum',
+      fulfillerComment: null,
+      display: 'Guitar Inspection',
+    },
+    {
+      uuid: 'order-uuid-3',
+      orderNumber: 'ORD-003',
+      patient: mockPatient2 as Patient,
+      dateActivated: '2021-01-01',
+      fulfillerStatus: 'RECEIVED',
+      urgency: 'EMERGENCY',
+      orderer: mockOrderer,
+      instructions: 'Make some noise',
+      fulfillerComment: null,
+      display: 'Sound Check',
+    },
+  ]
+    .filter((order) => !props.status || order.fulfillerStatus === props.status)
+    .filter((order) => !props.excludeCanceled || order.fulfillerStatus !== 'CANCELLED') as Array<Order>;
+  return {
+    labOrders,
+    isLoading: false,
+    isError: false,
+    mutate: jest.fn(),
+    isValidating: false,
+  };
+}
+
+describe('OrdersDataTable', () => {
+  beforeEach(() => {
+    mockUseLabOrders.mockImplementation(mockUseLabOrdersImplementation);
+  });
+
+  it('should render one row per patient and show lab details', async () => {
+    mockUseConfig.mockReturnValue({
+      ...getDefaultsFromConfigSchema(configSchema),
+    });
+
+    render(<OrdersDataTable />);
+    const table = screen.getByRole('table');
+    expect(table).toBeInTheDocument();
+    const rows = screen.getAllByRole('row');
+    expect(rows).toHaveLength(5);
+    const dataRows = rows.slice(1).filter((row) => !row.classList.contains('hiddenRow'));
+    expect(dataRows).toHaveLength(2);
+    const headerRow = rows[0];
+    expect(headerRow).toHaveTextContent('Patient');
+    expect(headerRow).toHaveTextContent('Age');
+    expect(headerRow).toHaveTextContent('Sex');
+    expect(headerRow).toHaveTextContent('Total Orders');
+    const row1 = dataRows[0];
+    expect(row1).toHaveTextContent('Pete Seeger');
+    expect(row1).toHaveTextContent('70');
+    expect(row1).toHaveTextContent('M');
+    expect(row1).toHaveTextContent('2');
+    const row2 = dataRows[1];
+    expect(row2).toHaveTextContent('Bob Dylan');
+    expect(row2).toHaveTextContent('60');
+    expect(row2).toHaveTextContent('M');
+    expect(row2).toHaveTextContent('1');
+
+    const user = userEvent.setup();
+    await user.click(within(row1).getByLabelText('Expand current row'));
+
+    const orderDetailsTables = within(table).getAllByRole('table');
+    expect(orderDetailsTables).toHaveLength(2);
+    const orderDetailsTable1 = orderDetailsTables[0];
+    const orderDetailsTable2 = orderDetailsTables[1];
+    expect(orderDetailsTable1).toHaveTextContent('Banjo Inspection');
+    expect(orderDetailsTable1).toHaveTextContent('Inspect banjo & check tuning');
+    expect(orderDetailsTable1).toHaveTextContent('Dr. John Doe');
+    expect(orderDetailsTable1).toHaveTextContent('01-Jan-2021');
+    expect(orderDetailsTable1).toHaveTextContent('Received');
+    expect(orderDetailsTable1).toHaveTextContent('Routine');
+    expect(orderDetailsTable2).toHaveTextContent('Guitar Inspection');
+    expect(orderDetailsTable2).toHaveTextContent('Give it a strum');
+    expect(orderDetailsTable2).toHaveTextContent('Dr. John Doe');
+    expect(orderDetailsTable2).toHaveTextContent('01-Jan-2021');
+    expect(orderDetailsTable2).toHaveTextContent('Received');
+    expect(orderDetailsTable2).toHaveTextContent('Routine');
+  });
+
+  it('should show patient identifier if it is configured', () => {
+    mockUseConfig.mockReturnValue({
+      ...getDefaultsFromConfigSchema(configSchema),
+      labTableColumns: ['patientId', 'age', 'totalOrders'],
+      patientIdIdentifierTypeUuid: 'identifier-type-uuid-1',
+    });
+    render(<OrdersDataTable />);
+    const rows = screen.getAllByRole('row');
+    expect(rows).toHaveLength(5);
+    const dataRows = rows.slice(1).filter((row) => !row.classList.contains('hiddenRow'));
+    expect(dataRows).toHaveLength(2);
+    const row1 = dataRows[0];
+    expect(row1).toHaveTextContent('PAT-001');
+    expect(row1).toHaveTextContent('70');
+    expect(row1).toHaveTextContent('2');
+    const row2 = dataRows[1];
+    expect(row2).toHaveTextContent('PAT-002');
+    expect(row2).toHaveTextContent('60');
+    expect(row2).toHaveTextContent('1');
+    expect(screen.queryByText(/BAD-ID/)).not.toBeInTheDocument();
+  });
+});

package/src/config-schema.ts

@@ -1,4 +1,7 @@
-import { Type } from '@openmrs/esm-framework';
+import { Type, validators } from '@openmrs/esm-framework';
+
+const allowedLabTableColumns = ['name', 'age', 'sex', 'totalOrders', 'action', 'patientId'] as const;
+type LabTableColumnName = (typeof allowedLabTableColumns)[number];
 
 export const configSchema = {
   laboratoryOrderTypeUuid: {
@@ -24,6 +27,20 @@ export const configSchema = {
     },
     _description: 'The patient chart dashboard to navigate to from the lab app.',
   },
+  labTableColumns: {
+    _type: Type.Array,
+    _default: ['name', 'age', 'sex', 'totalOrders', 'action'] as Array<LabTableColumnName>,
+    _description: 'The columns to display in the lab table. Allowed values: ' + allowedLabTableColumns.join(', '),
+    _elements: {
+      _type: Type.String,
+      _validators: [validators.oneOf(allowedLabTableColumns)],
+    },
+  },
+  patientIdIdentifierTypeUuid: {
+    _type: Type.UUID,
+    _default: '05a29f94-c0ed-11e2-94be-8c13b969e334',
+    _description: 'Needed if the "id" column of "labTableColumns" is used. Is the OpenMRS ID by default.',
+  },
 };
 
 export type Config = {
@@ -33,4 +50,6 @@ export type Config = {
     redirectToResultsViewer: string;
     redirectToOrders: string;
   };
+  labTableColumns: Array<LabTableColumnName>;
+  patientIdIdentifierTypeUuid: string;
 };

package/src/lab-tabs/data-table-extensions/tests-ordered-table.extension.tsx

@@ -6,7 +6,7 @@ const TestsOrderedTable: React.FC = () => {
     <OrdersDataTable
       excludeColumns={[]}
       actionsSlotName="tests-ordered-actions-slot"
-      fulfillerStatus="NEW"
+      newOrdersOnly={true}
       actions={[
         { actionName: 'pickupLabRequest', order: 0 },
         { actionName: 'rejectLabRequest', order: 1 },

package/src/lab-tiles/all-lab-requests-tile.component.tsx

@@ -6,7 +6,7 @@ import LabSummaryTile from '../components/summary-tile/lab-summary-tile.componen
 const AllLabRequestsTile = () => {
   const { t } = useTranslation();
 
-  const { labOrders } = useLabOrders('NEW');
+  const { labOrders } = useLabOrders({ newOrdersOnly: true });
 
   return (
     <LabSummaryTile

package/src/lab-tiles/completed-lab-requests-tile.component.tsx

@@ -5,7 +5,7 @@ import LabSummaryTile from '../components/summary-tile/lab-summary-tile.componen
 
 const CompletedLabRequestsTile = () => {
   const { t } = useTranslation();
-  const { labOrders } = useLabOrders('COMPLETED', false);
+  const { labOrders } = useLabOrders({ status: 'COMPLETED', excludeCanceled: false });
 
   return (
     <LabSummaryTile

package/src/lab-tiles/in-progress-lab-requests-tile.component.tsx

@@ -5,7 +5,7 @@ import LabSummaryTile from '../components/summary-tile/lab-summary-tile.componen
 
 const InProgressLabRequestsTile = () => {
   const { t } = useTranslation();
-  const { labOrders } = useLabOrders('IN_PROGRESS');
+  const { labOrders } = useLabOrders({ status: 'IN_PROGRESS' });
 
   return (
     <LabSummaryTile

package/src/laboratory-resource.ts

@@ -1,9 +1,22 @@
-import { useMemo } from 'react';
 import dayjs from 'dayjs';
 import useSWR from 'swr';
 import { openmrsFetch, restBaseUrl, useAppContext, useConfig } from '@openmrs/esm-framework';
-import { type Order } from '@openmrs/esm-patient-common-lib';
-import type { DateFilterContext, FulfillerStatus, GroupedOrders } from './types';
+import { type Order, type FulfillerStatus } from '@openmrs/esm-patient-common-lib';
+import type { DateFilterContext } from './types';
+
+const useLabOrdersDefaultParams: UseLabOrdersParams = {
+  status: null,
+  newOrdersOnly: false,
+  excludeCanceled: true,
+  includePatientId: false,
+}
+
+export interface UseLabOrdersParams {
+  status: FulfillerStatus;
+  newOrdersOnly: boolean;
+  excludeCanceled: boolean;
+  includePatientId: boolean;
+}
 
 /**
  * Custom hook for retrieving laboratory orders based on the specified status.
@@ -11,18 +24,18 @@ import type { DateFilterContext, FulfillerStatus, GroupedOrders } from './types'
  * @param status - The status of the orders to retrieve
  * @param excludeCanceled - Whether to exclude canceled, discontinued and expired orders
  */
-export function useLabOrders(status: 'NEW' | FulfillerStatus = null, excludeCanceled = true) {
+export function useLabOrders(params: Partial<UseLabOrdersParams> = useLabOrdersDefaultParams) {
+  const { status, newOrdersOnly, excludeCanceled, includePatientId } = { ...useLabOrdersDefaultParams, ...params };
   const { dateRange } = useAppContext<DateFilterContext>('laboratory-date-filter') ?? {
     dateRange: [dayjs().startOf('day').toDate(), new Date()],
   };
 
   const { laboratoryOrderTypeUuid } = useConfig();
-  const fulfillerStatus = useMemo(() => (status === 'NEW' ? null : status), [status]);
-  const newOrdersOnly = status === 'NEW';
-  const customRepresentation =
-    'custom:(uuid,orderNumber,patient:(uuid,display,person:(uuid,display,age,gender)),concept:(uuid,display),action,careSetting:(uuid,display,description,careSettingType,display),previousOrder,dateActivated,scheduledDate,dateStopped,autoExpireDate,encounter:(uuid,display),orderer:(uuid,display),orderReason,orderReasonNonCoded,orderType:(uuid,display,name,description,conceptClasses,parent),urgency,instructions,commentToFulfiller,display,fulfillerStatus,fulfillerComment,specimenSource,laterality,clinicalHistory,frequency,numberOfRepeats)';
+  const customRepresentation = `custom:(uuid,orderNumber,patient:(uuid,display,person:(uuid,display,age,gender)${
+    includePatientId ? ',identifiers' : ''
+  }),concept:(uuid,display),action,careSetting:(uuid,display,description,careSettingType,display),previousOrder,dateActivated,scheduledDate,dateStopped,autoExpireDate,encounter:(uuid,display),orderer:(uuid,display),orderReason,orderReasonNonCoded,orderType:(uuid,display,name,description,conceptClasses,parent),urgency,instructions,commentToFulfiller,display,fulfillerStatus,fulfillerComment,specimenSource,laterality,clinicalHistory,frequency,numberOfRepeats)`;
   let url = `${restBaseUrl}/order?orderTypes=${laboratoryOrderTypeUuid}&v=${customRepresentation}`;
-  url = fulfillerStatus ? url + `&fulfillerStatus=${fulfillerStatus}` : url;
+  url = status ? url + `&fulfillerStatus=${status}` : url;
   url = excludeCanceled ? `${url}&excludeCanceledAndExpired=true&excludeDiscontinueOrders=true` : url;
   // The usage of SWR's mutator seems to only suffice for cases where we don't apply a status filter
   url = dateRange
@@ -36,11 +49,9 @@ export function useLabOrders(status: 'NEW' | FulfillerStatus = null, excludeCanc
   }>(`${url}`, openmrsFetch);
 
   const filteredOrders =
-    data?.data &&
-    newOrdersOnly &&
-    data.data.results.filter((order) => order?.action === 'NEW' && order?.fulfillerStatus === null);
+    data?.data?.results?.filter((order) => !newOrdersOnly || (order?.action === 'NEW' && order?.fulfillerStatus === null));
   return {
-    labOrders: filteredOrders || data?.data.results || [],
+    labOrders: filteredOrders ?? [],
     isLoading,
     isError: error,
     mutate,
@@ -48,26 +59,6 @@ export function useLabOrders(status: 'NEW' | FulfillerStatus = null, excludeCanc
   };
 }
 
-export function useSearchGroupedResults(data: Array<GroupedOrders>, searchString: string) {
-  const searchResults = useMemo(() => {
-    if (searchString && searchString.trim() !== '') {
-      // Normalize the search string to lowercase
-      const lowerSearchString = searchString.toLowerCase();
-      return data.filter((orderGroup) =>
-        orderGroup.orders.some(
-          (order) =>
-            order.orderNumber.toLowerCase().includes(lowerSearchString) ||
-            order.patient.display.toLowerCase().includes(lowerSearchString),
-        ),
-      );
-    }
-
-    return data;
-  }, [searchString, data]);
-
-  return searchResults;
-}
-
 export function setFulfillerStatus(orderId: string, status: FulfillerStatus, abortController: AbortController) {
   return openmrsFetch(`${restBaseUrl}/order/${orderId}/fulfillerdetails/`, {
     method: 'POST',

package/src/types.ts

@@ -1,15 +1,27 @@
-import { type Order } from '@openmrs/esm-patient-common-lib';
+import { type Order, type FulfillerStatus, type OrderUrgency } from '@openmrs/esm-patient-common-lib';
 
-export type FulfillerStatus = 'EXCEPTION' | 'RECEIVED' | 'COMPLETED' | 'IN_PROGRESS' | 'ON_HOLD' | 'DECLINED' | 'NEW';
+export interface FlattenedOrder {
+  id: string;
+  patientUuid: string;
+  orderNumber: string;
+  display: string;
+  dateActivated: string;
+  fulfillerStatus: FulfillerStatus;
+  urgency: OrderUrgency;
+  orderer: string;
+  instructions: string;
+  fulfillerComment: string;
+}
 
 export interface GroupedOrders {
+  patientUuid: string;
   patientId: string;
-  orders: Array<Order>;
-}
-
-export interface ListOrdersDetailsProps {
-  groupedOrders: GroupedOrders;
-  actions: Array<OrderAction>;
+  patientName: string;
+  patientAge: number;
+  patientSex: string;
+  totalOrders: number;
+  orders: Array<FlattenedOrder>;
+  originalOrders: Array<Order>;
 }
 
 export interface OrderAction {
@@ -17,15 +29,6 @@ export interface OrderAction {
   order: 0 | number;
 }
 
-export interface OrdersDataTableProps {
-  useFilter?: boolean;
-  actionsSlotName?: string;
-  excludeColumns?: string[];
-  fulfillerStatus?: FulfillerStatus;
-  excludeCanceledAndDiscontinuedOrders?: boolean;
-  actions: Array<OrderAction>;
-}
-
 export type DateFilterContext = {
   dateRange: Array<Date>;
   setDateRange: React.Dispatch<React.SetStateAction<Array<Date>>>;

package/translations/en.json

@@ -18,14 +18,12 @@
   "exceptionStatus": "EXCEPTION",
   "filterOrdersByStatus": "Filter orders by status",
   "fulfillerComment": "Fulfiller comment",
-  "gender": "Gender",
   "In progress": "In progress",
   "inProgress": "In progress",
   "inProgressStatus": "IN_PROGRESS",
   "laboratory": "Laboratory",
   "Laboratory": "Laboratory",
   "loading": "Loading",
-  "newStatus": "NEW",
   "nextPage": "Next page",
   "NoInstructionLeft": "No instructions are provided.",
   "noLabRequestsFound": "No lab requests found",
@@ -40,6 +38,7 @@
   "orders": "Orders",
   "orderStatus": "Status:",
   "patient": "Patient",
+  "patientId": "Patient ID",
   "pickedAnOrder": "Picked an order",
   "pickRequest": "Pick lab request",
   "pickRequestConfirmationText": "Continuing will update the request status to \"In Progress\" and advance it to the next stage. Are you sure you want to proceed?",
@@ -55,6 +54,7 @@
   "rejectLabRequestTitle": "Lab request rejected",
   "results": "Results",
   "searchThisList": "Search this list",
+  "sex": "Sex",
   "tabletOverlay": "Tablet overlay",
   "testOrdered": "Test ordered: ",
   "Tests ordered": "Tests ordered",

package/.turbo/cache/8b374b02de72bb4b-meta.json

@@ -1 +0,0 @@
-{"hash":"8b374b02de72bb4b","duration":50422}