(feat) Test types should be filterable by synonyms (#2006)

* (feat) Test types should be filterable by synonyms * Review feedback Co-authored-by: Ian <[email protected]> * Fix tests --------- Co-authored-by: Ian <[email protected]>
openmrs · Sep 10, 2024 · 2f7ab2f · 2f7ab2f
1 parent 8438c66
commit 2f7ab2f
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 7 deletions.
diff --git a/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/add-lab-order.test.tsx b/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/add-lab-order.test.tsx
@@ -34,10 +34,17 @@ const mockTestTypes = [
   {
     conceptUuid: 'test-lab-uuid-1',
     label: 'HIV VIRAL LOAD',
+    synonyms: ['HIV VIRAL LOAD', 'HIV VL'],
   },
   {
     conceptUuid: 'test-lab-uuid-2',
     label: 'CD4 COUNT',
+    synonyms: ['CD4 COUNT', 'CD4'],
+  },
+  {
+    conceptUuid: 'test-lab-uuid-3',
+    label: 'HEMOGLOBIN',
+    synonyms: ['HEMOGLOBIN', 'HGB'],
   },
 ];
 const mockUseTestTypes = jest.fn().mockReturnValue({
@@ -200,6 +207,15 @@ describe('AddLabOrder', () => {
     expect(screen.getByText('04 — Apr — 1972')).toBeInTheDocument();
   });
 
+  test('should be possible to search for test types by synonyms', async () => {
+    const user = userEvent.setup();
+    renderAddLabOrderWorkspace();
+    const searchInput = screen.getByRole('searchbox');
+    await user.type(searchInput, 'hgb');
+    await screen.findByText(/hemoglobin/i);
+    expect(screen.queryByText(/hiv viral load/i)).not.toBeInTheDocument();
+  });
+
   test('should display an error message if test types fail to load', () => {
     mockUseTestTypes.mockReturnValue({
       testTypes: [],

diff --git a/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/test-type-search.component.tsx b/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/test-type-search.component.tsx
@@ -74,7 +74,9 @@ function TestTypeSearchResults({ searchTerm, openOrderForm, focusAndClearSearchI
     }
 
     if (searchTerm && searchTerm.trim() !== '') {
-      return testTypes.filter((testType) => testType.label.toLowerCase().includes(searchTerm.toLowerCase()));
+      return testTypes?.filter((testType) =>
+        testType.synonyms.some((name) => name.toLowerCase().includes(searchTerm.toLowerCase())),
+      );
     }
   }, [searchTerm, testTypes]);
 

diff --git a/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/useTestTypes.test.ts b/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/useTestTypes.test.ts
@@ -40,10 +40,10 @@ mockOpenrsFetch.mockImplementation((url: string) => {
 });
 
 describe('useTestTypes is configurable', () => {
-  it('should return all Test concepts when no labOrderableConcepts are provided', async () => {
+  it('should return all test concepts when no labOrderableConcepts are provided', async () => {
     const { result } = renderHook(() => useTestTypes());
     expect(mockOpenrsFetch).toHaveBeenCalledWith(
-      '/ws/rest/v1/concept?class=Test?v=custom:(display,uuid,setMembers:(display,uuid,setMembers:(display,uuid)))',
+      '/ws/rest/v1/concept?class=Test?v=custom:(display,names:(display),uuid,setMembers:(display,uuid,names:(display),setMembers:(display,uuid,names:(display))))',
     );
     await waitFor(() => expect(result.current.isLoading).toBeFalsy());
     expect(result.current.error).toBeFalsy();
@@ -54,7 +54,7 @@ describe('useTestTypes is configurable', () => {
     const { result } = renderHook(() => useTestTypes());
     expect(mockOpenrsFetch).toHaveBeenCalledWith(
       expect.stringContaining(
-        '/ws/rest/v1/concept?class=Test?v=custom:(display,uuid,setMembers:(display,uuid,setMembers:(display,uuid)))',
+        '/ws/rest/v1/concept?class=Test?v=custom:(display,names:(display),uuid,setMembers:(display,uuid,names:(display),setMembers:(display,uuid,names:(display))))',
       ),
     );
     await waitFor(() => expect(result.current.isLoading).toBeFalsy());

diff --git a/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/useTestTypes.ts b/packages/esm-patient-labs-app/src/lab-orders/add-lab-order/useTestTypes.ts
@@ -10,6 +10,7 @@ type ConceptResults = FetchResponse<{ results: Array<Concept> }>;
 export interface TestType {
   label: string;
   conceptUuid: string;
+  synonyms: string[];
 }
 
 export interface UseTestType {
@@ -31,9 +32,9 @@ function useTestConceptsSWR(labOrderableConcepts?: Array<string>) {
       labOrderableConcepts
         ? labOrderableConcepts.map(
             (c) =>
-              `${restBaseUrl}/concept/${c}?v=custom:(display,uuid,setMembers:(display,uuid,setMembers:(display,uuid)))`,
+              `${restBaseUrl}/concept/${c}?v=custom:(display,names:(display),uuid,setMembers:(display,uuid,names:(display),setMembers:(display,uuid,names:(display))))`,
           )
-        : `${restBaseUrl}/concept?class=Test?v=custom:(display,uuid,setMembers:(display,uuid,setMembers:(display,uuid)))`,
+        : `${restBaseUrl}/concept?class=Test?v=custom:(display,names:(display),uuid,setMembers:(display,uuid,names:(display),setMembers:(display,uuid,names:(display))))`,
     (labOrderableConcepts ? openmrsFetchMultiple : openmrsFetch) as any,
     {
       shouldRetryOnError(err) {
@@ -58,7 +59,6 @@ function useTestConceptsSWR(labOrderableConcepts?: Array<string>) {
 
 export function useTestTypes(): UseTestType {
   const { labOrderableConcepts } = useConfig<ConfigObject>().orders;
-
   const { data, isLoading, error } = useTestConceptsSWR(labOrderableConcepts.length ? labOrderableConcepts : null);
 
   useEffect(() => {
@@ -73,6 +73,7 @@ export function useTestTypes(): UseTestType {
         ?.map((concept) => ({
           label: concept.display,
           conceptUuid: concept.uuid,
+          synonyms: concept.names?.flatMap((name) => name.display) ?? [],
         }))
         ?.sort((testConcept1, testConcept2) => testConcept1.label.localeCompare(testConcept2.label))
         ?.filter((item, pos, array) => !pos || array[pos - 1].conceptUuid !== item.conceptUuid),

diff --git a/packages/esm-patient-labs-app/src/types.ts b/packages/esm-patient-labs-app/src/types.ts
@@ -77,6 +77,9 @@ export interface Concept {
     display: string;
     name: string;
   };
+  names: Array<{
+    display: string;
+  }>;
   answers: [];
   setMembers: [];
   hiNormal: number;