@kenyaemr/esm-express-workflow-app 5.4.3 → 5.4.4-pre.1

package/src/hooks/useServiceQueues.tsx

@@ -1,68 +1,138 @@
-import { openmrsFetch, restBaseUrl, useConfig } from '@openmrs/esm-framework';
-import dayjs from 'dayjs';
 import { useMemo } from 'react';
-import useSWR from 'swr';
-import { ExpressWorkflowConfig } from '../config-schema';
-import { Queue, QueueEntry, QueueEntryFilters } from '../types/index';
+import useSWRImmutable from 'swr/immutable';
+import dayjs from 'dayjs';
+import { openmrsFetch, restBaseUrl, useConfig, useOpenmrsPagination } from '@openmrs/esm-framework';
+
+import { type ExpressWorkflowConfig } from '../config-schema';
+import { QueueEntriesPagination, type Queue, type QueueEntry, type QueueEntryFilters } from '../types/index';
+
+const QUEUE_LIST_REP =
+  'custom:(uuid,display,name,location:(uuid,display),service:(uuid,display),queueRooms:(uuid,display))';
+
+const SWR_QUEUE_OPTIONS = {
+  dedupingInterval: 5000,
+  revalidateOnFocus: false,
+} as const;
 
 export const useQueues = () => {
-  const { data, isLoading, error } = useSWR<{ data: { results: Array<Queue> } }>(
-    '/ws/rest/v1/queue?v=full',
+  const queueListKey = `/ws/rest/v1/queue?v=${encodeURIComponent(QUEUE_LIST_REP)}`;
+  const { data, isLoading, error, isValidating } = useSWRImmutable<{ data: { results: Array<Queue> } }>(
+    queueListKey,
     openmrsFetch,
+    SWR_QUEUE_OPTIONS,
   );
 
   return {
     queues: data?.data?.results || [],
     isLoading,
     error,
+    isValidating,
   };
 };
 
-export const useQueueEntries = (filters?: QueueEntryFilters) => {
+export const useQueueEntries = (filters?: QueueEntryFilters, defaultPageSize: number = 10) => {
   const { outpatientVisitTypeUuid } = useConfig<ExpressWorkflowConfig>();
   const repString =
-    'custom:(uuid,display,queue,status,patient:(uuid,display,person,identifiers:(uuid,display,identifier,identifierType)),visit:(uuid,display,startDatetime,visitType:(uuid,display),encounters:(uuid,display,diagnoses,encounterDatetime,encounterType,obs,encounterProviders,voided),attributes:(uuid,display,value,attributeType)),priority,priorityComment,sortWeight,startedAt,endedAt,locationWaitingFor,queueComingFrom,providerWaitingFor,previousQueueEntry)';
+    'custom:(uuid,display,queue:(uuid,display,name,location:(uuid,display)),status:(uuid,display),patient:(uuid,person,identifiers:(uuid,display,identifier,identifierType:(uuid,display))),visit:(uuid,visitType:(uuid),attributes:(uuid,value,attributeType:(uuid))),priority:(uuid,display),priorityComment,startedAt,previousQueueEntry:(uuid,queue:(uuid,display)))';
 
-  const buildQueryParams = (filters?: QueueEntryFilters & { status: string[] }): string => {
+  const queryString = useMemo(() => {
     const params = new URLSearchParams();
     params.append('v', repString);
 
-    if (filters) {
-      Object.entries(filters).forEach(([key, value]) => {
-        if (value !== undefined && value !== null) {
-          if (Array.isArray(value)) {
-            value.forEach((v) => params.append(key, v));
-          } else {
-            params.append(key, String(value));
-          }
+    const merged = {
+      ...filters,
+      status: filters?.statuses ?? [],
+      statuses: undefined,
+      startedOnOrAfter: filters?.startedOnOrAfter ?? undefined,
+      startedOnOrBefore: filters?.startedOnOrBefore ?? undefined,
+      queue: filters?.queues ?? [],
+    };
+    if (merged) {
+      Object.entries(merged).forEach(([key, value]) => {
+        if (key === 'statuses' || value === undefined || value === null) {
+          return;
+        }
+        if (Array.isArray(value)) {
+          [...value].sort((a, b) => String(a).localeCompare(String(b))).forEach((v) => params.append(key, v));
+        } else {
+          params.append(key, String(value));
         }
       });
     }
 
-    if (!filters || filters.isEnded === undefined || filters.isEnded === null) {
+    if (filters?.isEnded == null) {
       params.append('isEnded', 'false');
     }
 
     return params.toString();
-  };
+  }, [
+    filters?.location?.join(','),
+    filters?.service?.join(','),
+    [...(filters?.statuses ?? [])].sort((a, b) => String(a).localeCompare(String(b))).join(','),
+    filters?.priorities?.join(','),
+    filters?.patient,
+    filters?.visit,
+    filters?.hasVisit,
+    filters?.isEnded,
+    filters?.locationsWaitingFor?.join(','),
+    filters?.providersWaitingFor?.join(','),
+    filters?.queuesComingFrom?.join(','),
+    filters?.queues?.join(','),
+  ]);
 
-  const queryString = buildQueryParams({ ...filters, status: filters?.statuses ?? [], statuses: [] });
-  const url = `/ws/rest/v1/queue-entry${queryString ? `?${queryString}` : ''}`;
+  const url = queryString ? `/ws/rest/v1/queue-entry?${queryString}` : '/ws/rest/v1/queue-entry';
+
+  const {
+    data,
+    isLoading,
+    isValidating,
+    error,
+    totalPages,
+    totalCount,
+    currentPage,
+    currentPageSize,
+    paginated,
+    showNextButton,
+    showPreviousButton,
+    goTo,
+    goToNext,
+    goToPrevious,
+  } = useOpenmrsPagination<QueueEntry>(url, defaultPageSize, {
+    swrConfig: {
+      revalidateOnFocus: true,
+      keepPreviousData: true,
+    },
+  });
 
-  const { data, isLoading, error } = useSWR<{ data: { results: Array<QueueEntry> } }>(url, openmrsFetch);
   const queueEntries = useMemo(() => {
-    return (data?.data?.results ?? [])?.filter((entry) => {
+    return (data ?? [])?.filter((entry) => {
       return (
         dayjs(entry.startedAt).isAfter(dayjs().subtract(24, 'hour')) &&
         entry?.visit?.visitType?.uuid === outpatientVisitTypeUuid
       );
     });
-  }, [data?.data?.results, outpatientVisitTypeUuid]);
+  }, [data, outpatientVisitTypeUuid]);
+
+  const pagination: QueueEntriesPagination = {
+    totalPages,
+    totalCount,
+    currentPage,
+    currentPageSize,
+    paginated,
+    showNextButton,
+    showPreviousButton,
+    goTo,
+    goToNext,
+    goToPrevious,
+    defaultPageSize,
+  };
 
   return {
     queueEntries,
     isLoading,
+    isValidating,
     error,
+    pagination,
   };
 };
 export function serveQueueEntry(servicePointName: string, ticketNumber: string, status: string, locationUuid?: string) {

package/src/index.ts

@@ -1,11 +1,20 @@
-import { defineConfigSchema, getAsyncLifecycle, getSyncLifecycle } from '@openmrs/esm-framework';
+import { defineConfigSchema, getAsyncLifecycle, registerFeatureFlag } from '@openmrs/esm-framework';
 import { configSchema } from './config-schema';
-import CheckinFormExtraExtension from './components/registration/checkin-form-extra/checkin-form-extra.extension';
-import { Home } from '@carbon/react/icons';
-
-import PatientSummaryDashboard from './shared/patient-chart/patient-summary-dashboard/patient-summary-dashboard.component';
-import { createLeftPanelLink } from './shared/dashboard-link/dashboard-link.component';
-
+export * from './components/accounting';
+export * from './components/admissions';
+export * from './components/appointments';
+export * from './components/consultation';
+export * from './components/facility-dashboard';
+export * from './components/laboratory';
+export * from './components/mch';
+export * from './components/pharmacy';
+export * from './components/preauth';
+export * from './components/procedures';
+export * from './components/procedures/procedure-queues';
+export * from './components/radiology-and-imaging';
+export * from './components/registration';
+export * from './components/reports';
+export * from './components/triage';
 const moduleName = '@kenyaemr/esm-express-workflow-app';
 
 const options = {
@@ -17,35 +26,82 @@ export const importTranslation = require.context('../translations', false, /.jso
 
 export function startupApp() {
   defineConfigSchema(moduleName, configSchema);
+  registerFeatureFlag(
+    'procedureQueues',
+    'Procedure Queues',
+    'Enable/Disable procedure queue in procedure pannel and procedure form',
+  );
 }
-export * from './components/facility-dashboard';
-export * from './components/registration';
-export * from './components/triage';
-export * from './components/accounting';
-export * from './components/consultation';
-export * from './components/mch';
-export * from './components/reports';
-export * from './components/pharmacy';
-export * from './components/laboratory';
-export * from './components/radiology-and-imaging';
-export * from './components/procedures';
-export * from './components/admissions';
-export * from './components/appointments';
 
 export const root = getAsyncLifecycle(() => import('./root.component'), options);
 export const otpVerificationModal = getAsyncLifecycle(
   () => import('./shared/otp-verification/otp-verification.modal'),
   options,
 );
-export const checkinFormExtraExtension = getSyncLifecycle(CheckinFormExtraExtension, options);
-export const patientSummaryDashboard = getSyncLifecycle(PatientSummaryDashboard, options);
+export const checkinFormExtraExtension = getAsyncLifecycle(
+  () => import('./components/registration/checkin-form-extra/checkin-form-extra.extension'),
+  options,
+);
+export const patientSummaryDashboard = getAsyncLifecycle(
+  () => import('./shared/patient-chart/patient-summary-dashboard/patient-summary-dashboard.component'),
+  options,
+);
+
+export const customStartVisitOverflowMenuItem = getAsyncLifecycle(
+  () => import('./components/registration/start-visit-form/overflow-menu-extension/overflow-menu-item.extension'),
+  {
+    featureName: 'patient-actions-slot-start-visit-button',
+    moduleName,
+  },
+);
+export const customStopVisitOverflowMenuItem = getAsyncLifecycle(
+  () => import('./components/registration/start-visit-form/overflow-menu-extension/custom-end-active-visit.extension'),
+  {
+    featureName: 'patient-actions-slot-stop-visit-button',
+    moduleName,
+  },
+);
+
+export const visitFormWorkspace = getAsyncLifecycle(
+  () => import('./components/registration/start-visit-form/visit-form-workspace/visit-form.workspace'),
+  options,
+);
+
+export const customEndVisitModal = getAsyncLifecycle(
+  () => import('./components/registration/end-visit-modal/end-visit-dialog.modal'),
+  {
+    featureName: 'custom-patient-actions-end-visit-modal',
+    moduleName,
+  },
+);
+
+export const anaestheticFormWorkspace = getAsyncLifecycle(
+  () => import('./components/anaesthetic/forms/anaesthetic-form.component'),
+  options,
+);
+
+export const interoperativeDrugGivenFormWorkspace = getAsyncLifecycle(
+  () => import('./components/anaesthetic/forms/interoperative-record-drug-given-form.component'),
+  options,
+);
 
 export const queuesAdminHome = getAsyncLifecycle(() => import('./shared/queue/queues-home.component'), options);
-export const homepageDashboardLink = getSyncLifecycle(
-  createLeftPanelLink({
-    name: `consultation`,
-    title: 'Home',
-    icon: Home,
-  }),
+
+export const homepageDashboardLink = getAsyncLifecycle(
+  () =>
+    Promise.all([import('./shared/dashboard-link/dashboard-link.component'), import('@carbon/react/icons')]).then(
+      ([m, icons]) => ({
+        default: m.createLeftPanelLink({
+          name: 'consultation',
+          title: 'Home',
+          icon: icons.Home,
+        }),
+      }),
+    ),
+  options,
+);
+
+export const procedureAndOrdersTab = getAsyncLifecycle(
+  () => import('./shared/tabs/create-tab-extension').then((mod) => ({ default: mod.createTabExtension() })),
   options,
 );

package/src/routes.json

@@ -2,7 +2,7 @@
   "$schema": "https://json.openmrs.org/routes.schema.json",
   "backendDependencies": {
     "fhir2": ">=1.2",
-   "webservices.rest": ">=2.24.0"
+    "webservices.rest": ">=2.24.0"
   },
   "pages": [
     {
@@ -12,10 +12,6 @@
     {
       "component": "queuesAdminHome",
       "route": "queues-admin"
-    },
-    {
-      "component": "appointmentsDashboard",
-      "route": "appointments"
     }
   ],
   "extensions": [
@@ -29,6 +25,27 @@
         "title": "Appointments"
       }
     },
+    {
+      "name": "ewf-preauth-dashboard-link",
+      "component": "preauthDashboardLink",
+      "slot": "patient-chart-dashboard-slot",
+      "order": 10,
+      "meta": {
+        "name": "ewf-preauth",
+        "title": "Preauthorization",
+        "path": "preauthorization",
+        "slot": "ewf-preauth-dashboard-slot",
+        "layoutMode": "anchored",
+        "hideDashboardTitle": true
+      }
+    },
+    {
+      "name": "ewf-preauth-dashboard",
+      "component": "preauthDashboard",
+      "slot": "ewf-patient-chart-preauth-dashboard-slot",
+      "online": true,
+      "offline": false
+    },
     {
       "component": "admissionsLeftPanelLink",
       "name": "admissions-dashboard-link",
@@ -125,7 +142,7 @@
     {
       "name": "custom-visit-form-queue-fields",
       "component": "checkinFormExtraExtension",
-      "slot":"visit-form-bottom-slot",
+      "slot": "visit-form-bottom-slot",
       "order": 0
     },
     {
@@ -193,7 +210,7 @@
       "online": true,
       "offline": false
     },
-     {
+    {
       "name": "ewf-laboratory-dashboard-link",
       "component": "laboratoryLeftPanelLink",
       "slot": "patient-chart-dashboard-slot",
@@ -266,15 +283,15 @@
         "hideDashboardTitle": true
       }
     },
-
-        {
+    {
       "name": "ewf-pharmacy-dashboard",
       "component": "pharmacyTabs",
       "slot": "ewf-patient-chart-pharmacy-dashboard-slot",
       "online": true,
       "offline": false
     },
-    {"name": "ewf-admissions-dashboard-link",
+    {
+      "name": "ewf-admissions-dashboard-link",
       "component": "admissionsDashboardLink",
       "slot": "patient-chart-dashboard-slot",
       "meta": {
@@ -305,38 +322,279 @@
       "slot": "ewf-clinical-encounter-slot",
       "online": true,
       "offline": false
+    },
+    {
+      "name": "custom-start-visit-overflow-menu-item",
+      "slot": "patient-actions-slot",
+      "component": "customStartVisitOverflowMenuItem",
+      "online": true,
+      "offline": true
+    },
+    {
+      "name": "custom-stop-visit-overflow-menu-item",
+      "component": "customStopVisitOverflowMenuItem",
+      "online": true,
+      "offline": true
+    },
+    {
+      "name": "procedure-queues",
+      "component": "procedureQueues",
+      "online": true,
+      "offline": false,
+      "featureFlag": "procedureQueues",
+      "slot": "procedure-orders-dashboard-slot"
+    },
+    {
+      "name": "procedure-form-extras",
+      "component": "procedureFormExtras",
+      "slot": "procedure-order-form-extras-slot",
+      "online": true,
+      "offline": false,
+      "featureFlag": "procedureQueues"
+    },
+    {
+      "name": "ewf-patient-summary-tab",
+      "component": "patientSummary",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "patientSummaryTab",
+        "slot": "ewf-patient-summary-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-vitals-tab",
+      "component": "patientVitals",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "vitalsAndAnthropometric",
+        "slot": "ewf-vitals-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-care-panel-tab",
+      "component": "carePanel",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "carePanel",
+        "slot": "ewf-care-panel-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-immunization-tab",
+      "component": "immunization",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "immunizations",
+        "slot": "ewf-immunizations-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-relationships-tab",
+      "component": "relationships",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "relationships",
+        "slot": "ewf-relationships-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-appointments-tab",
+      "component": "appointments",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "appointments",
+        "slot": "ewf-appointments-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-attachments-tab",
+      "component": "attachments",
+      "slot": "ewf-patient-chart-patient-summary-tabs-extension-slot",
+      "meta": {
+        "title": "attachments",
+        "slot": "ewf-attachments-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-clinical-encounter-tab",
+      "component": "patientClinicalEncounter",
+      "slot": "clinical-encounter-tabs-slot",
+      "meta": {
+        "title": "clinicalEncounterTab",
+        "slot": "ewf-clinical-encounter-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-visits-tab",
+      "component": "patientVisits",
+      "slot": "clinical-encounter-tabs-slot",
+      "meta": {
+        "title": "visits",
+        "slot": "ewf-visits-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-special-clinics-tab",
+      "component": "specialClinics",
+      "slot": "clinical-encounter-tabs-slot",
+      "meta": {
+        "title": "specialClinics",
+        "slot": "ewf-special-clinics-slot"
+      }
+    },
+    {
+      "name": "ewf-clinical-notes-tab",
+      "component": "clinicalNotes",
+      "meta": {
+        "title": "clinicalNotes",
+        "slot": "ewf-clinical-notes-slot"
+      }
+    },
+    {
+      "name": "ewf-procedures-and-orders-tab",
+      "component": "proceduresAndOrders",
+      "meta": {
+        "title": "proceduresAndOrders",
+        "slot": "ewf-procedures-and-orders-slot"
+      }
+    },
+    {
+      "name": "ewf-pharmacy-orders-tab",
+      "component": "pharmacyOrdersTab",
+      "slot": "pharmacy-tabs-slot",
+      "meta": {
+        "title": "orders",
+        "slot": "ewf-orders-slot"
+      }
+    },
+    {
+      "name": "ewf-pharmacy-active-medication-tab",
+      "component": "pharmacyActiveMedicationsTab",
+      "slot": "pharmacy-tabs-slot",
+      "meta": {
+        "title": "activeMedications",
+        "slot": "ewf-active-medications-slot"
+      }
+    },
+    {
+      "name": "ewf-pharmacy-past-medication-tab",
+      "component": "pharmacyPastMedicationsTab",
+      "slot": "pharmacy-tabs-slot",
+      "meta": {
+        "title": "pastMedications",
+        "slot": "ewf-past-medications-slot"
+      }
+    },
+    {
+      "name": "ewf-patient-lab-orders-tab",
+      "component": "patientLaboratoryOrdersTab",
+      "slot": "patient-laboratory-tabs-slot",
+      "meta": {
+        "title": "orders"
+      }
+    },
+    {
+      "name": "ewf-patient-lab-order-results-tab",
+      "component": "patientLaboratoryOrdersResults",
+      "slot": "patient-laboratory-tabs-slot",
+      "meta": {
+        "title": "results",
+        "slot": "ewf-laboratory-results-slot",
+        "basePath": "laboratory"
+      }
+    },
+    {
+      "name": "ewf-patient-procedure-orders-tab",
+      "component": "patientProcedureOrdersTab",
+      "slot": "patient-procedure-tabs-slot",
+      "meta": {
+        "title": "orders"
+      }
+    },
+    {
+      "name": "ewf-patient-procedure-order-results-tab",
+      "component": "patientProcedureOrdersResults",
+      "slot": "patient-procedure-tabs-slot",
+      "meta": {
+        "title": "results",
+        "slot": "ewf-procedures-results-slot",
+        "basePath": "procedures"
+      }
+    },
+    {
+      "name": "ewf-patient-procedure-anaesthetic-tab",
+      "component": "patientProcedureAnaestheticTab",
+      "slot": "patient-procedure-tabs-slot",
+      "meta": {
+        "title": "anaesthetic"
+      }
+    },
+    {
+      "name": "ewf-patient-imaging-orders-tab",
+      "component": "patientImagingOrdersTab",
+      "slot": "patient-imaging-tabs-slot",
+      "meta": {
+        "title": "orders"
+      }
+    },
+    {
+      "name": "ewf-patient-imaging-order-results-tab",
+      "component": "patientImagingOrdersResults",
+      "slot": "patient-imaging-tabs-slot",
+      "meta": {
+        "title": "results",
+        "slot": "ewf-radiology-and-imaging-results-slot",
+        "basePath": "radiology-and-imaging"
+      }
     }
   ],
-
-  "workspaces": [
-    {
-      "name": "express-workflow-workspace",
-      "component": "expressWorkflowWorkspace",
-      "title": "Express Workflow Workspace",
-      "type": "workspace",
-      "canMaximize": true,
-      "canHide": true
+  "workspaces2": [
+    {
+      "name": "custom-start-visit-workspace-form",
+      "component": "visitFormWorkspace",
+      "window": "ewf-start-visit"
+    },
+    {
+      "name": "anaesthetic-record-workspace-form",
+      "component": "anaestheticFormWorkspace",
+      "window": "ewf-anaesthetic-record"
+    },
+    {
+      "name": "interoperative-drug-given-workspace-form",
+      "component": "interoperativeDrugGivenFormWorkspace",
+      "window": "ewf-anaesthetic-record"
+    }
+  ],
+  "workspaceWindows2": [
+    {
+      "name": "ewf-start-visit",
+      "group": "patient-chart",
+      "width": "wider"
+    },
+    {
+      "name": "ewf-anaesthetic-record",
+      "group": "ewf-patient-chart",
+      "width": "wider"
+    }
+  ],
+  "workspaceGroups2": [
+    {
+      "name": "ewf-patient-chart",
+      "scopePattern": "/patient/([^/]+)/chart"
     }
   ],
   "modals": [
     {
       "component": "otpVerificationModal",
       "name": "otp-verification-modal"
-    }, {
+    },
+    {
       "component": "facilityDashboardAuthorizationModal",
       "name": "facility-dashboard-authorization-form-modal"
-    }
-  ],
-  "workspaceGroups": [
-    {
-      "name": "express-workflow",
-      "members": [
-        "add-drug-order",
-        "order-basket",
-        "add-lab-order",
-        "express-workflow-workspace",
-        "start-visit-workspace-form"
-      ]
+    },
+    {
+      "name": "custom-end-visit-dialog",
+      "component": "customEndVisitModal"
     }
   ]
 }