@openmrs/esm-ward-app 9.2.1-pre.7244 → 9.2.1-pre.7261

package/src/routes.json

@@ -40,41 +40,16 @@
       "name": "ward-patient-action-button",
       "slot": "action-menu-ward-patient-items-slot"
     },
-    {
-      "component": "wardPatientNotesActionButtonExtension",
-      "name": "ward-inpatient-notes-form-action-button",
-      "slot": "action-menu-ward-patient-items-slot"
-    },
     {
       "component": "coloredObsTagCardRowExtension",
       "name": "colored-obs-tags-card-row",
       "slot": "ward-patient-card-slot"
     },
-    {
-      "name": "transfer-swap-patient-siderail-button",
-      "slot": "action-menu-ward-patient-items-slot",
-      "component": "patientTransferAndSwapWorkspaceSiderailIcon"
-    },
     {
       "name": "patient-discharge-siderail-button",
       "slot": "action-menu-ward-patient-items-slot",
       "component": "patientDischargeWorkspaceSideRailIcon"
     },
-    {
-      "name": "clinical-forms-workspace-siderail-button",
-      "component": "clinicalFormWorkspaceSideRailIcon",
-      "slot": "action-menu-ward-patient-items-slot"
-    },
-    {
-      "name": "admission-requests-workspace-siderail-button",
-      "component": "admissionRequestsWorkspaceSideRailIcon",
-      "slot": "action-menu-ward-patient-admission-requests-items-slot"
-    },
-    {
-      "name": "create-admission-request-workspace-siderail-button",
-      "component": "createAdmissionEncounterWorkspaceSideRailIcon",
-      "slot": "action-menu-ward-patient-admission-requests-items-slot"
-    },
     {
       "component": "defaultWardView",
       "name": "default-ward",
@@ -91,93 +66,165 @@
       "slot": "ward-workspace-patient-banner-slot"
     }
   ],
-  "workspaces": [
+  "workspaces2": [
     {
       "name": "admission-requests-workspace",
       "component": "admissionRequestWorkspace",
-      "title": "admissionRequests",
-      "type": "pending-admission-requests",
-      "width": "wider"
-    },{
-      "name": "create-admission-encounter-workspace",
-      "component": "createAdmissionEncounterWorkspace",
-      "title": "admitPatient",
-      "type": "patient-search-workspace",
-      "width": "wider"
+      "window": "pending-admissions"
     },
     {
-      "name": "ward-patient-notes-workspace",
-      "component": "wardPatientNotesWorkspace",
-      "type": "ward-patient-notes",
-      "title": "inpatientNotesWorkspaceTitle"
-
+      "name": "transfer-elsewhere-workspace",
+      "component": "patientTransferRequestWorkspace",
+      "window": "pending-admissions"
+    },
+    {
+      "name": "cancel-admission-request-workspace",
+      "component": "cancelAdmissionRequestWorkspace",
+      "window": "pending-admissions"
     },
     {
       "name": "admit-patient-form-workspace",
       "component": "admitPatientFormWorkspace",
-      "title": "admissionRequests",
-      "type": "admission-requests"
+      "window": "pending-admissions"
+    },
+
+    {
+      "name": "ward-app-patient-search-workspace",
+      "component": "@openmrs/esm-patient-search-app#patientSearchWorkspace2",
+      "window": "add-patient-to-ward"
+    },
+    {
+      "name": "ward-app-start-visit-workspace",
+      "component": "@openmrs/esm-patient-chart-app#exportedVisitForm",
+      "window": "add-patient-to-ward"
     },
+    {
+      "name": "create-admission-encounter-workspace",
+      "component": "createAdmissionEncounterWorkspace",
+      "window": "add-patient-to-ward"
+    },
+
+    
     {
       "name": "ward-patient-workspace",
       "component": "wardPatientWorkspace",
-      "type": "ward",
-      "title": "Ward patient",
-      "width": "extra-wide"
+      "window": "ward-patient"
     },
     {
-      "name": "patient-transfer-swap-workspace",
-      "component": "patientTransferAndSwapWorkspace",
-      "title": "transfers",
-      "type": "transfer-swap-bed-form"
+      "name": "ward-patient-vitals-workspace",
+      "component": "@openmrs/esm-patient-vitals-app#exportedVitalsBiometricsFormWorkspace",
+      "window": "ward-patient"
+    },
+
+    {
+      "name": "ward-patient-notes-workspace",
+      "component": "wardPatientNotesWorkspace",
+      "window": "ward-patient-notes"
 
     },
     {
-      "name": "patient-transfer-request-workspace",
-      "component": "patientTransferRequestWorkspace",
-      "title": "transferRequest",
-      "type": "transfer-request-form"
+      "name": "ward-patient-transfer-swap-workspace",
+      "component": "patientTransferAndSwapWorkspace",
+      "window": "ward-patient-transfer-swap"
     },
     {
       "name": "patient-discharge-workspace",
       "component": "patientDischargeWorkspace",
-      "title": "discharge",
-      "type": "ward-patient-discharge"
+      "window": "ward-patient-discharge"
     },
     {
       "name": "ward-patient-clinical-forms-workspace",
-      "component": "patientClinicalFormsWorkspace",
-      "title": "clinicalForms",
-      "type": "ward-patient-clinical-forms",
+      "component": "@openmrs/esm-patient-forms-app#exportedClinicalFormsWorkspace",
+      "window": "ward-patient-clinical-forms"
+    },
+    {
+      "name": "ward-patient-form-entry-workspace",
+      "component": "@openmrs/esm-patient-forms-app#exportedPatientFormEntryWorkspace",
+      "window": "ward-patient-clinical-forms"
+    },
+    {
+      "name": "ward-patient-cancel-admission-request-workspace",
+      "component": "wardPatientCancelAdmissionRequestWorkspace",
+      "window": "ward-patient-cancel-admission-request"
+    },
+    {
+      "name": "ward-patient-order-basket-workspace",
+      "component": "@openmrs/esm-patient-orders-app#exportedOrderBasketWorkspace",
+      "window": "ward-patient-order-basket"
+    },
+    {
+      "name": "ward-patient-order-basket-add-drug-order-workspace",
+      "component": "@openmrs/esm-patient-medications-app#exportedAddDrugOrderWorkspace",
+      "window": "ward-patient-order-basket"
+    },
+    {
+      "name": "ward-patient-order-basket-add-lab-order-workspace",
+      "component": "@openmrs/esm-patient-tests-app#exportedAddLabOrderWorkspace",
+      "window": "ward-patient-order-basket"
+    },
+    {
+      "name": "ward-patient-order-basket-add-general-order-workspace",
+      "component": "@openmrs/esm-patient-orders-app#exportedOrderBasketWorkspace",
+      "window": "ward-patient-order-basket"
+    }
+  ],
+  "workspaceWindows2": [
+    {
+      "name": "pending-admissions",
+      "group": "ward-manage-admissions",
+      "icon": "admissionRequestsWorkspaceSideRailIcon",
       "width": "wider"
     },
     {
-      "name": "cancel-admission-request-workspace",
-      "component": "cancelAdmissionRequestWorkspace",
-      "title": "cancelAdmissionRequest",
-      "type": "cancel-admission-request"
+      "name": "add-patient-to-ward",
+      "group": "ward-manage-admissions",
+      "icon": "createAdmissionEncounterWorkspaceSideRailIcon"
+    },
+
+    {
+      "name": "ward-patient",
+      "group": "ward-patient",
+      "icon": "wardPatientActionButton",
+      "width": "wider"
+    },
+    {
+      "name": "ward-patient-notes",
+      "group": "ward-patient",
+      "icon": "wardPatientNotesActionButton"
+    },
+    {
+      "name": "ward-patient-transfer-swap",
+      "group": "ward-patient",
+      "icon": "patientTransferAndSwapWorkspaceSiderailIcon"
+    },
+    {
+      "name": "ward-patient-discharge",
+      "group": "ward-patient",
+      "icon": "patientDischargeWorkspaceSideRailIcon"
+    },
+    {
+      "name": "ward-patient-clinical-forms",
+      "group": "ward-patient",
+      "icon": "clinicalFormWorkspaceSideRailIcon"
+    },
+    {
+      "name": "ward-patient-order-basket",
+      "group": "ward-patient",
+      "icon": "orderBasketWorkspaceSideRailIcon"
+    },
+    {
+      "name": "ward-patient-cancel-admission-request",
+      "group": "ward-patient"
     }
   ],
-  "workspaceGroups": [
+  "workspaceGroups2": [
+    {
+      "name": "ward-manage-admissions",
+      "overlay": true
+    },
     {
       "name": "ward-patient",
-      "members": [
-        "ward-patient-workspace",
-        "ward-patient-notes-workspace",
-        "patient-transfer-swap-workspace",
-        "patient-discharge-workspace",
-        "ward-patient-clinical-forms-workspace",
-        "add-drug-order",
-        "order-basket",
-        "add-lab-order"
-      ]
-    },
-    {
-      "name": "ward-patient-admission-requests",
-      "members": [
-        "admission-requests-workspace",
-        "create-admission-encounter-workspace"
-      ]
+      "overlay": true
     }
   ]
 }

package/src/types/index.ts

@@ -7,6 +7,7 @@ import type {
   Patient,
   Person,
   Visit,
+  Workspace2DefinitionProps,
 } from '@openmrs/esm-framework';
 import type React from 'react';
 import type { useWardPatientGrouping } from '../hooks/useWardPatientGrouping';
@@ -50,7 +51,7 @@ export type WardPatient = {
   inpatientRequest: InpatientRequest;
 };
 
-export interface WardPatientWorkspaceProps extends DefaultWorkspaceProps {
+export interface WardPatientWorkspaceProps {
   wardPatient: WardPatient;
 
   /**
@@ -60,6 +61,11 @@ export interface WardPatientWorkspaceProps extends DefaultWorkspaceProps {
   relatedTransferPatients?: WardPatient[];
 }
 
+/**
+ * props type of workspaces in the 'ward-patient` workspace group.
+ */
+export type WardPatientWorkspaceDefinition = Workspace2DefinitionProps<{}, {}, { wardPatient: WardPatient }>;
+
 // server-side types defined in openmrs-module-bedmanagement:
 
 // note "AdmissionLocationResponse" isn't the clearest name, but it matches the endpoint; endpoint fetches bed information (including info about patients in those beds) for a location (as provided by the bed management module)
@@ -271,5 +277,3 @@ export interface MaternalWardViewContext {
   [key: number]: unknown;
   [key: symbol]: unknown;
 }
-
-export type PatientWorkspaceAdditionalProps = Omit<WardPatientWorkspaceProps, keyof DefaultWorkspaceProps>;

package/src/ward-patient-card/row-elements/ward-patient-pending-transfer.component.tsx

@@ -1,6 +1,6 @@
 import { IconButton } from '@carbon/react';
 import { Movement } from '@carbon/react/icons';
-import { CloseOutlineIcon, launchWorkspace } from '@openmrs/esm-framework';
+import { CloseOutlineIcon, launchWorkspace, launchWorkspace2 } from '@openmrs/esm-framework';
 import React, { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
 import { type WardPatient, type WardPatientWorkspaceProps } from '../../types';
@@ -28,9 +28,14 @@ const WardPatientPendingTransfer: React.FC<WardPatientTransferProps> = ({ wardPa
   }, [dispositionType, dispositionLocation, t]);
 
   const launchCancelAdmissionForm = () => {
-    launchWorkspace<WardPatientWorkspaceProps>('cancel-admission-request-workspace', {
-      wardPatient,
-    });
+    launchWorkspace2(
+      'ward-patient-cancel-admission-request-workspace',
+      {},
+      {},
+      {
+        wardPatient,
+      },
+    );
   };
 
   if (!(dispositionType === 'TRANSFER' || dispositionType === 'DISCHARGE')) return null;

package/src/ward-patient-card/ward-patient-card.component.tsx

@@ -1,5 +1,5 @@
 import React, { type ReactNode } from 'react';
-import { getPatientName, launchWorkspaceGroup } from '@openmrs/esm-framework';
+import { getPatientName, launchWorkspace2 } from '@openmrs/esm-framework';
 import { type WardPatient } from '../types';
 import styles from './ward-patient-card.scss';
 
@@ -23,16 +23,8 @@ const WardPatientCard: React.FC<Props> = ({ children, wardPatient, relatedTransf
       <button
         className={styles.wardPatientCardButton}
         onClick={() => {
-          launchWorkspaceGroup('ward-patient', {
-            state: {
-              wardPatient,
-              patient,
-              patientUuid: patient.uuid,
-              relatedTransferPatients,
-            },
-            workspaceToLaunch: {
-              name: 'ward-patient-workspace',
-            },
+          launchWorkspace2('ward-patient-workspace', {}, {}, {
+            wardPatient
           });
         }}>
         {getPatientName(patient.person)}

package/src/ward-view-header/admission-requests-bar.component.tsx

@@ -3,7 +3,14 @@ import classNames from 'classnames';
 import { useTranslation } from 'react-i18next';
 import { Button, InlineNotification } from '@carbon/react';
 import { Movement } from '@carbon/react/icons';
-import { ArrowRightIcon, isDesktop, launchWorkspaceGroup, useAppContext, useLayoutType } from '@openmrs/esm-framework';
+import {
+  ArrowRightIcon,
+  isDesktop,
+  launchWorkspace2,
+  launchWorkspaceGroup,
+  useAppContext,
+  useLayoutType,
+} from '@openmrs/esm-framework';
 import { type WardViewContext } from '../types';
 import styles from './admission-requests.scss';
 
@@ -46,11 +53,8 @@ const AdmissionRequestsBar: React.FC<AdmissionRequestsBarProps> = ({ wardPending
       <Button
         className={styles.manageButton}
         onClick={() => {
-          launchWorkspaceGroup('ward-patient-admission-requests', {
-            state: { wardPendingPatients },
-            workspaceToLaunch: {
-              name: 'admission-requests-workspace',
-            },
+          launchWorkspace2('admission-requests-workspace', {
+            wardPendingPatients,
           });
         }}
         renderIcon={ArrowRightIcon}

package/src/ward-view-header/admission-requests-bar.test.tsx

@@ -1,4 +1,4 @@
-import { launchWorkspaceGroup, useAppContext } from '@openmrs/esm-framework';
+import { launchWorkspace2, launchWorkspaceGroup, useAppContext } from '@openmrs/esm-framework';
 import { screen } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import React from 'react';
@@ -8,14 +8,14 @@ import { type WardViewContext } from '../types';
 import AdmissionRequestsBar from './admission-requests-bar.component';
 
 jest.mocked(useAppContext<WardViewContext>).mockReturnValue(mockWardViewContext);
-const mockUseConfig = jest.mocked(launchWorkspaceGroup);
+const mockLaunchWorkspace = jest.mocked(launchWorkspace2);
 describe('Admission Requests Button', () => {
   it('should launch workspace when clicked on manage button', async () => {
     const user = userEvent.setup();
     renderWithSwr(<AdmissionRequestsBar wardPendingPatients={[]} />);
 
     await user.click(screen.getByRole('button', { name: /manage/i }));
-    expect(mockUseConfig).toHaveBeenCalled();
+    expect(mockLaunchWorkspace).toHaveBeenCalled();
   });
 
   it('should have one admission request', () => {

package/src/ward-workspace/admission-request-card/admission-request-card-actions.component.tsx

@@ -1,25 +1,24 @@
 import React from 'react';
 import { Button } from '@carbon/react';
 import { useTranslation } from 'react-i18next';
-import { launchWorkspace, useLayoutType } from '@openmrs/esm-framework';
-import { useAdmissionRequestsWorkspaceContext } from '../admission-request-workspace/admission-requests-context';
+import { closeWorkspaceGroup2, launchWorkspace2, useLayoutType, useWorkspace2Context } from '@openmrs/esm-framework';
 import type { WardPatientCardType, WardPatientWorkspaceProps } from '../../types';
 import AdmitPatientButton from '../admit-patient-button.component';
 import styles from './admission-request-card.scss';
 
 const AdmissionRequestCardActions: WardPatientCardType = ({ wardPatient }) => {
   const { t } = useTranslation();
-  const { closeWorkspaceWithSavedChanges } = useAdmissionRequestsWorkspaceContext();
   const responsiveSize = useLayoutType() === 'tablet' ? 'lg' : 'md';
+  const { closeWorkspace } = useWorkspace2Context();
 
   const launchPatientTransferForm = () => {
-    launchWorkspace<WardPatientWorkspaceProps>('patient-transfer-request-workspace', {
+    launchWorkspace2<WardPatientWorkspaceProps, {}, {}>('transfer-elsewhere-workspace', {
       wardPatient,
     });
   };
 
   const launchCancelAdmissionForm = () => {
-    launchWorkspace<WardPatientWorkspaceProps>('cancel-admission-request-workspace', {
+    launchWorkspace2<WardPatientWorkspaceProps, {}, {}>('cancel-admission-request-workspace', {
       wardPatient,
     });
   };
@@ -37,7 +36,10 @@ const AdmissionRequestCardActions: WardPatientCardType = ({ wardPatient }) => {
       <AdmitPatientButton
         wardPatient={wardPatient}
         dispositionType={wardPatient.inpatientRequest.dispositionType}
-        onAdmitPatientSuccess={() => closeWorkspaceWithSavedChanges()}
+        onAdmitPatientSuccess={async () => {
+          await closeWorkspace({ discardUnsavedChanges: true });
+          closeWorkspaceGroup2();
+        }}
       />
     </div>
   );

package/src/ward-workspace/admission-request-workspace/admission-requests-action-button.extension.tsx

@@ -1,18 +1,17 @@
 import React from 'react';
+import { ActionMenuButton2, UserAvatarIcon } from '@openmrs/esm-framework';
 import { useTranslation } from 'react-i18next';
-import { ActionMenuButton, launchWorkspace, UserAvatarIcon } from '@openmrs/esm-framework';
-import { type AdmissionRequestsWorkspaceContextProps } from './admission-requests-context';
 
 export default function AdmissionRequestsActionButton() {
   const { t } = useTranslation();
 
   return (
-    <ActionMenuButton
-      getIcon={(props) => <UserAvatarIcon {...props} />}
-      handler={() => launchWorkspace<AdmissionRequestsWorkspaceContextProps>('admission-requests-workspace')}
-      iconDescription={t('pendingAdmissions', 'Pending admissions')}
+    <ActionMenuButton2
+      icon={(props) => <UserAvatarIcon {...props} />}
       label={t('pendingAdmissions', 'Pending admissions')}
-      type={'pending-admission-requests'}
+      workspaceToLaunch={{
+        workspaceName: 'admission-requests-workspace',
+      }}
     />
   );
 }

package/src/ward-workspace/admission-request-workspace/admission-requests-empty-state.component.tsx

@@ -1,10 +1,9 @@
-import React, { useState } from 'react';
+import React from 'react';
 import classNames from 'classnames';
 import { useTranslation } from 'react-i18next';
 import { Layer, Tile, Button } from '@carbon/react';
 import { Add } from '@carbon/react/icons';
-import { launchWorkspace, useLayoutType } from '@openmrs/esm-framework';
-import { type CreateAdmissionEncounterWorkspaceProps } from '../create-admission-encounter/create-admission-encounter.workspace';
+import { launchWorkspace2, useLayoutType, type Workspace2DefinitionProps } from '@openmrs/esm-framework';
 import { EmptyDataIllustration } from './empty-data-illustration.component';
 import styles from './admission-requests-empty-state.scss';
 
@@ -12,36 +11,24 @@ const AdmissionRequestsEmptyState: React.FC = () => {
   const { t } = useTranslation();
   const isDesktop = useLayoutType() !== 'tablet';
 
-  // TODO: this is an attempt to save the previous search term for the
-  // "Back to patient search" button, but it doesn't work. See:
-  // https://openmrs.atlassian.net/browse/O3-4300
-  const [searchTerm, setSearchTerm] = useState<string>('');
-
-  const launchSearchWorkspace = () => {
-    // See PatientSearchWorkspaceProps in patient-search-app
-    const workspaceProps = {
-      initialQuery: searchTerm,
-      nonNavigationSelectPatientAction: async (patientUuid: string) => {
-        launchWorkspace<CreateAdmissionEncounterWorkspaceProps>('create-admission-encounter-workspace', {
-          patientUuid,
-          handleReturnToSearchList: launchSearchWorkspace,
-        });
-      },
-      handleSearchTermUpdated: (value: string) => {
-        setSearchTerm(value);
+  const handleAddPatient = () => {
+    launchWorkspace2('ward-app-patient-search-workspace', {
+      workspaceProps: {
+        workspaceTitle: t('addPatientToQueue', 'Add patient to queue'),
+        onPatientSelected(
+          patientUuid: string,
+          patient: fhir.Patient,
+          launchChildWorkspace: Workspace2DefinitionProps['launchChildWorkspace'],
+          closeWorkspace: Workspace2DefinitionProps['launchChildWorkspace'],
+        ) {
+          launchChildWorkspace('create-admission-encounter-workspace', {
+            selectedPatientUuid: patient.id,
+          });
+        },
       },
-    };
-
-    launchWorkspace('patient-search-workspace', {
-      ...workspaceProps,
-      workspaceTitle: t('addPatientToWard', 'Add patient to ward'),
     });
   };
 
-  const handleAddPatient = () => {
-    launchSearchWorkspace();
-  };
-
   return (
     <Layer>
       <Tile className={classNames(styles.emptyStateTile, { [styles.desktopTile]: isDesktop })}>

package/src/ward-workspace/admission-request-workspace/admission-requests-workspace.test.tsx

@@ -1,25 +1,30 @@
 import React from 'react';
 import { screen } from '@testing-library/react';
-import { useAppContext } from '@openmrs/esm-framework';
+import { useAppContext, useWorkspace2Context, type Workspace2DefinitionProps } from '@openmrs/esm-framework';
 import { renderWithSwr } from 'tools';
 import { mockWardViewContext } from '../../../mock';
-import { type AdmissionRequestsWorkspaceContextProps } from './admission-requests-context';
 import { type WardViewContext } from '../../types';
 import useEmrConfiguration from '../../hooks/useEmrConfiguration';
 import DefaultWardPendingPatients from '../../ward-view/default-ward/default-ward-pending-patients.component';
-import AdmissionRequestsWorkspace from './admission-requests.workspace';
+import AdmissionRequestsWorkspace, { type AdmissionRequestsWorkspaceProps } from './admission-requests.workspace';
 
 jest.mocked(useAppContext<WardViewContext>).mockReturnValue(mockWardViewContext);
+const mockUseWorkspace2Context = jest.mocked(useWorkspace2Context);
 
 jest.mock('../../hooks/useEmrConfiguration', () => jest.fn());
 const mockedUseEmrConfiguration = jest.mocked(useEmrConfiguration);
 
-const workspaceProps: AdmissionRequestsWorkspaceContextProps = {
+const workspaceProps: Workspace2DefinitionProps<AdmissionRequestsWorkspaceProps> = {
   closeWorkspace: jest.fn(),
-  promptBeforeClosing: jest.fn(),
-  closeWorkspaceWithSavedChanges: jest.fn(),
-  setTitle: jest.fn(),
-  wardPendingPatients: <DefaultWardPendingPatients />,
+  launchChildWorkspace: jest.fn(),
+  workspaceProps: {
+    wardPendingPatients: <DefaultWardPendingPatients />,
+  },
+  windowProps: undefined,
+  groupProps: undefined,
+  workspaceName: '',
+  windowName: '',
+  isRootWorkspace: false,
 };
 
 describe('Admission Requests Workspace', () => {
@@ -43,6 +48,16 @@ describe('Admission Requests Workspace', () => {
       },
       mutateEmrConfiguration: jest.fn(),
     });
+    mockUseWorkspace2Context.mockReturnValue({
+      closeWorkspace: jest.fn(),
+      launchChildWorkspace: jest.fn(),
+      workspaceProps: undefined,
+      windowProps: undefined,
+      groupProps: undefined,
+      workspaceName: '',
+      windowName: '',
+      isRootWorkspace: false,
+    });
   });
 
   it('should render an admission request card', () => {