@kenyaemr/esm-billing-app 5.3.8-pre.1599 → 5.3.9-pre.1620

package/dist/routes.json

@@ -1 +1 @@
-{"$schema":"https://json.openmrs.org/routes.schema.json","backendDependencies":{"kenyaemr":"^19.0.0"},"pages":[{"component":"billableServicesHome","route":"billable-services"},{"component":"requirePaymentModal","routeRegex":"^patient/.+/chart","online":true,"offline":false}],"extensions":[{"component":"billingDashboardLink","name":"billing-dashboard-link","slot":"homepage-dashboard-slot","meta":{"name":"billing","title":"billing","slot":"billing-dashboard-slot"}},{"component":"benefitsPackageDashboardLink","name":"benefits-package-dashboard-link","slot":"patient-chart-dashboard-slot","meta":{"name":"benefits-package","slot":"patient-chart-benefits-dashboard-slot","path":"insurance-benefits","columns":1,"columnSpan":1},"featureFlag":"healthInformationExchange"},{"component":"benefitsPackage","name":"benefits-package","slot":"patient-chart-benefits-dashboard-slot"},{"component":"root","name":"billing-dashboard-root","slot":"billing-dashboard-slot"},{"component":"benefitsEligibilyRequestForm","name":"benefits-eligibility-request-form"},{"component":"benefitsPreAuthForm","name":"benefits-pre-auth-form"},{"name":"billing-patient-summary","component":"billingPatientSummary","slot":"patient-chart-billing-dashboard-slot","order":10,"meta":{"columnSpan":4}},{"name":"billing-summary-dashboard-link","component":"billingSummaryDashboardLink","slot":"patient-chart-dashboard-slot","order":11,"meta":{"columns":1,"columnSpan":1,"slot":"patient-chart-billing-dashboard-slot","path":"Billing","layoutMode":"anchored"}},{"name":"billing-check-in-form","slot":"extra-visit-attribute-slot","component":"billingCheckInForm"},{"name":"require-billing-modal","component":"requirePaymentModal"},{"name":"patient-banner-billing-tags","component":"visitAttributeTags","slot":"patient-banner-tags-slot","order":2},{"name":"initiate-payment-modal","component":"initiatePaymentDialog"},{"name":"delete-billableservice-modal","component":"deleteBillableServiceModal"},{"name":"refund-bill-modal","component":"refundBillModal"},{"name":"delete-bill-modal","component":"deleteBillModal"},{"name":"lab-order-billable-item","component":"labOrder","slot":"top-of-lab-order-form-slot"},{"name":"procedure-order-billable-item","component":"procedureOrder","slot":"top-of-procedure-order-form-slot"},{"name":"imaging-order-billable-item","component":"imagingOrder","slot":"top-of-imaging-order-form-slot"},{"name":"price-info-order","component":"priceInfoOrder"},{"name":"drug-order-billable-item","component":"drugOrder","slot":"medication-info-slot"},{"name":"billing-test-order-action","component":"testOrderAction","slot":"tests-ordered-actions-slot","order":0},{"component":"billingOverviewLink","name":"billing-overview-link","slot":"billing-dashboard-link-slot"},{"component":"paymentHistoryLink","name":"payment-history-link","slot":"billing-dashboard-link-slot"},{"component":"paymentPointsLink","name":"payment-points-link","slot":"billing-dashboard-link-slot"},{"component":"paymentModesLink","name":"payment-modes-link","slot":"billing-dashboard-link-slot"},{"component":"billManagerLink","name":"bill-manager-link","slot":"billing-dashboard-link-slot"},{"component":"chargeableItemsLink","name":"chargeable-items-link","slot":"billing-dashboard-link-slot"},{"component":"billableExemptionsLink","name":"billable-exemptions-link","slot":"billing-dashboard-link-slot"},{"component":"claimsManagementSideNavGroup","name":"claims-management-dashboard-link","slot":"homepage-dashboard-slot","meta":{"name":"claims-management","title":"Claims management Overview","slot":"case-management-slot"},"featureFlag":"healthInformationExchange"},{"component":"claimsManagementOverviewDashboardLink","name":"claims-management-overview-link","slot":"claims-management-dashboard-link-slot"},{"component":"preAuthRequestsDashboardLink","name":"preauthrequest-overview-link","slot":"claims-management-dashboard-link-slot"},{"component":"claimsOverview","name":"claims-overview-dashboard-link","slot":"claims-management-overview-slot"},{"component":"waiveBillActionButton","name":"waive-bill-action-button","slot":"bill-actions-slot"},{"component":"deleteBillActionButton","name":"delete-bill-action-button","slot":"bill-actions-slot"},{"component":"refundLineItem","name":"refund-line-item","slot":"bill-actions-overflow-menu-slot"},{"name":"edit-line-item","component":"editLineItem","slot":"bill-actions-overflow-menu-slot"},{"name":"cancel-line-item","component":"cancelLineItem","slot":"bill-actions-overflow-menu-slot"}],"workspaces":[{"name":"waive-bill-form","component":"waiveBillForm","title":"Waive Bill Form","type":"other-form"},{"name":"edit-bill-form","component":"editBillForm","title":"Edit Bill Form","type":"other-form"},{"name":"billable-service-form","component":"addServiceForm","title":"Create Charge Item Form","type":"other-form"},{"name":"commodity-form","component":"addCommodityForm","title":"Create Charge Item Form","type":"other-form"},{"name":"billing-form","component":"billingForm","title":"Billing Form","type":"other-form","width":"extra-wide"},{"name":"payment-mode-workspace","component":"paymentModeWorkspace","title":"Payment Mode Workspace","type":"other-form"},{"name":"cancel-bill-workspace","component":"cancelBillWorkspace","title":"Cancel Bill Workspace","type":"other-form"}],"modals":[{"name":"create-payment-point","component":"createPaymentPoint"},{"name":"clock-in-modal","component":"clockIn"},{"name":"clock-out-modal","component":"clockOut"},{"name":"bulk-import-billable-services-modal","component":"bulkImportBillableServicesModal"},{"name":"delete-payment-mode-modal","component":"deletePaymentModeModal"},{"name":"retry-claim-request-modal","component":"retryClaimRequestModal"},{"name":"paid-bill-receipt-print-preview-modal","component":"paidBillReceiptPrintPreviewModal"}],"version":"5.3.8-pre.1599"}
+{"$schema":"https://json.openmrs.org/routes.schema.json","backendDependencies":{"kenyaemr":"^19.0.0"},"pages":[{"component":"billableServicesHome","route":"billable-services"},{"component":"requirePaymentModal","routeRegex":"^patient/.+/chart","online":true,"offline":false}],"extensions":[{"component":"billingDashboardLink","name":"billing-dashboard-link","slot":"homepage-dashboard-slot","meta":{"name":"billing","title":"billing","slot":"billing-dashboard-slot"}},{"component":"benefitsPackageDashboardLink","name":"benefits-package-dashboard-link","slot":"patient-chart-dashboard-slot","meta":{"name":"benefits-package","slot":"patient-chart-benefits-dashboard-slot","path":"insurance-benefits","columns":1,"columnSpan":1},"featureFlag":"healthInformationExchange"},{"component":"benefitsPackage","name":"benefits-package","slot":"patient-chart-benefits-dashboard-slot"},{"component":"root","name":"billing-dashboard-root","slot":"billing-dashboard-slot"},{"component":"benefitsEligibilyRequestForm","name":"benefits-eligibility-request-form"},{"component":"benefitsPreAuthForm","name":"benefits-pre-auth-form"},{"name":"billing-patient-summary","component":"billingPatientSummary","slot":"patient-chart-billing-dashboard-slot","order":10,"meta":{"columnSpan":4}},{"name":"billing-summary-dashboard-link","component":"billingSummaryDashboardLink","slot":"patient-chart-dashboard-slot","order":11,"meta":{"columns":1,"columnSpan":1,"slot":"patient-chart-billing-dashboard-slot","path":"Billing","layoutMode":"anchored"}},{"name":"billing-check-in-form","slot":"extra-visit-attribute-slot","component":"billingCheckInForm"},{"name":"require-billing-modal","component":"requirePaymentModal"},{"name":"patient-banner-billing-tags","component":"visitAttributeTags","slot":"patient-banner-tags-slot","order":2},{"name":"initiate-payment-modal","component":"initiatePaymentDialog"},{"name":"delete-billableservice-modal","component":"deleteBillableServiceModal"},{"name":"refund-bill-modal","component":"refundBillModal"},{"name":"delete-bill-modal","component":"deleteBillModal"},{"name":"lab-order-billable-item","component":"labOrder","slot":"top-of-lab-order-form-slot"},{"name":"procedure-order-billable-item","component":"procedureOrder","slot":"top-of-procedure-order-form-slot"},{"name":"imaging-order-billable-item","component":"imagingOrder","slot":"top-of-imaging-order-form-slot"},{"name":"price-info-order","component":"priceInfoOrder"},{"name":"drug-order-billable-item","component":"drugOrder","slot":"medication-info-slot"},{"name":"billing-test-order-action","component":"testOrderAction","slot":"tests-ordered-actions-slot","order":0},{"component":"billingOverviewLink","name":"billing-overview-link","slot":"billing-dashboard-link-slot"},{"component":"paymentHistoryLink","name":"payment-history-link","slot":"billing-dashboard-link-slot"},{"component":"paymentPointsLink","name":"payment-points-link","slot":"billing-dashboard-link-slot"},{"component":"paymentModesLink","name":"payment-modes-link","slot":"billing-dashboard-link-slot"},{"component":"billManagerLink","name":"bill-manager-link","slot":"billing-dashboard-link-slot"},{"component":"chargeableItemsLink","name":"chargeable-items-link","slot":"billing-dashboard-link-slot"},{"component":"billableExemptionsLink","name":"billable-exemptions-link","slot":"billing-dashboard-link-slot"},{"component":"claimsManagementSideNavGroup","name":"claims-management-dashboard-link","slot":"homepage-dashboard-slot","meta":{"name":"claims-management","title":"Claims management Overview","slot":"case-management-slot"},"featureFlag":"healthInformationExchange"},{"component":"claimsManagementOverviewDashboardLink","name":"claims-management-overview-link","slot":"claims-management-dashboard-link-slot"},{"component":"preAuthRequestsDashboardLink","name":"preauthrequest-overview-link","slot":"claims-management-dashboard-link-slot"},{"component":"claimsOverview","name":"claims-overview-dashboard-link","slot":"claims-management-overview-slot"},{"component":"waiveBillActionButton","name":"waive-bill-action-button","slot":"bill-actions-slot"},{"component":"deleteBillActionButton","name":"delete-bill-action-button","slot":"bill-actions-slot"},{"component":"refundLineItem","name":"refund-line-item","slot":"bill-actions-overflow-menu-slot"},{"name":"edit-line-item","component":"editLineItem","slot":"bill-actions-overflow-menu-slot"},{"name":"cancel-line-item","component":"cancelLineItem","slot":"bill-actions-overflow-menu-slot"}],"workspaces":[{"name":"waive-bill-form","component":"waiveBillForm","title":"Waive Bill Form","type":"other-form"},{"name":"edit-bill-form","component":"editBillForm","title":"Edit Bill Form","type":"other-form"},{"name":"billable-service-form","component":"addServiceForm","title":"Create Charge Item Form","type":"other-form"},{"name":"commodity-form","component":"addCommodityForm","title":"Create Charge Item Form","type":"other-form"},{"name":"billing-form","component":"billingForm","title":"Billing Form","type":"other-form","width":"extra-wide"},{"name":"payment-mode-workspace","component":"paymentModeWorkspace","title":"Payment Mode Workspace","type":"other-form"},{"name":"cancel-bill-workspace","component":"cancelBillWorkspace","title":"Cancel Bill Workspace","type":"other-form"}],"modals":[{"name":"create-payment-point","component":"createPaymentPoint"},{"name":"clock-in-modal","component":"clockIn"},{"name":"clock-out-modal","component":"clockOut"},{"name":"bulk-import-billable-services-modal","component":"bulkImportBillableServicesModal"},{"name":"delete-payment-mode-modal","component":"deletePaymentModeModal"},{"name":"retry-claim-request-modal","component":"retryClaimRequestModal"},{"name":"paid-bill-receipt-print-preview-modal","component":"paidBillReceiptPrintPreviewModal"}],"version":"5.3.9-pre.1620"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kenyaemr/esm-billing-app",
-  "version": "5.3.8-pre.1599",
+  "version": "5.3.9-pre.1620",
   "description": "Billing app for KenyaEMR",
   "browser": "dist/kenyaemr-esm-billing-app.js",
   "main": "src/index.ts",
@@ -51,5 +51,5 @@
   "devDependencies": {
     "webpack": "^5.74.0"
   },
-  "stableVersion": "5.3.7"
+  "stableVersion": "5.3.8"
 }

package/src/billable-services/payment-history/payment-history-table.component.tsx

@@ -59,6 +59,7 @@ export const PaymentHistoryTable = ({
     return {
       ...row,
       totalAmount: convertToCurrency(row.payments.reduce((acc, payment) => acc + payment.amountTendered, 0)),
+      referenceCodes: row.payments.map(({ attributes }) => attributes.map(({ value }) => value).join(' ')).join(', '),
     };
   });
 
@@ -71,18 +72,18 @@ export const PaymentHistoryTable = ({
     });
     const data = dataForExport.map((row: (typeof transformedRows)[0]) => {
       return {
+        'Receipt Number': row.receiptNumber,
         'Patient ID': row.identifier,
         'Patient Name': row.patientName,
-        'Receipt Number': row.receiptNumber,
-        'Total Amount': row.lineItems.reduce((acc, item) => acc + item.price, 0),
-        'Payment Mode': row.payments.map((payment: (typeof row.payments)[0]) => payment.instanceType.name).join(', '),
-        'Payment Date': dayjs(row.payments[0].dateCreated).format('DD-MM-YYYY'),
-        'Payment Amount': row.payments.reduce((acc, payment) => acc + payment.amountTendered, 0),
+        'Mode of Payment': row.payments
+          .map((payment: (typeof row.payments)[0]) => payment.instanceType.name)
+          .join(', '),
+        'Total Amount Due': row.lineItems.reduce((acc, item) => acc + item.price, 0),
+        'Date of Payment': dayjs(row.payments[0].dateCreated).format('DD-MM-YYYY'),
+        'Total Amount Paid': row.payments.reduce((acc, payment) => acc + payment.amountTendered, 0),
         'Reason/Reference': row.payments
-          .map((payment: (typeof row.payments)[0]) =>
-            payment.attributes.map((attribute: (typeof payment.attributes)[0]) => attribute.attributeType.name),
-          )
-          .join(' '),
+          .map(({ attributes }) => attributes.map(({ value }) => value).join(' '))
+          .join(', '),
       };
     });
 

package/src/config-schema.ts

@@ -28,6 +28,10 @@ export interface BillingConfig {
     emergencyPriorityConceptUuid: string;
   };
   paymentMethodsUuidsThatShouldNotShowPrompt: Array<string>;
+  promptDuration: {
+    enable: boolean;
+    duration: number;
+  };
 }
 
 export const configSchema: ConfigSchema = {
@@ -182,4 +186,13 @@ export const configSchema: ConfigSchema = {
     },
     _default: ['beac329b-f1dc-4a33-9e7c-d95821a137a6'],
   },
+  promptDuration: {
+    _type: Type.Object,
+    _description:
+      'The duration in hours for the prompt to be shown, if the duration is less than this, the prompt will be shown',
+    _default: {
+      enable: true,
+      duration: 24,
+    },
+  },
 };

package/src/helpers/functions.ts

@@ -65,24 +65,19 @@ export const getGender = (gender: string, t) => {
 
 /**
  * Extracts and returns the substring after the first colon (:) in the input string.
- * The input string is expected to be in the format "uuid:string".
+ * If there's no colon or the input is invalid, returns the original string.
+ * The input string is typically in the format "uuid:string".
  *
  * @param {string} input - The input string from which the substring is to be extracted.
- * @returns {string} The substring found after the first colon in the input string.
+ * @returns {string} The substring found after the first colon, or the original string if no colon is present.
  */
 export function extractString(input: string): string {
-  const parts = input
-    .split(' ')
-    .map((s) => s.split(':')[1])
-    .filter((s) => Boolean(s));
-
-  const firstTwoBillableServices = parts.slice(0, 2);
-
-  if (parts.length <= 2) {
-    return firstTwoBillableServices.join(', ');
+  if (!input || typeof input !== 'string') {
+    return '';
   }
 
-  return `${firstTwoBillableServices.join(', ')} & ${parts.length - 2} other services`;
+  const parts = input.split(':');
+  return parts.length > 1 ? parts[1] : input;
 }
 
 // cleans the provider display name

package/src/invoice/invoice-table.component.tsx

@@ -21,7 +21,7 @@ import {
   type DataTableRow,
 } from '@carbon/react';
 import { isDesktop, useDebounce, useLayoutType } from '@openmrs/esm-framework';
-import { LineItem, MappedBill } from '../types';
+import { LineItem, MappedBill, PaymentStatus } from '../types';
 import styles from './invoice-table.scss';
 
 type InvoiceTableProps = {
@@ -155,10 +155,14 @@ const InvoiceTable: React.FC<InvoiceTableProps> = ({ bill, isSelectable = true,
                         <TableSelectRow
                           aria-label="Select row"
                           {...getSelectionProps({ row })}
-                          disabled={tableRows[index].status === 'PAID'}
+                          disabled={
+                            tableRows[index].status === PaymentStatus.PAID ||
+                            tableRows[index].status === PaymentStatus.EXEMPTED
+                          }
                           onChange={(checked: boolean) => handleRowSelection(row, checked)}
                           checked={
-                            tableRows[index].status === 'PAID' ||
+                            tableRows[index].status === PaymentStatus.PAID ||
+                            tableRows[index].status === PaymentStatus.EXEMPTED ||
                             Boolean(selectedLineItems?.find((item) => item?.uuid === row?.id))
                           }
                         />

package/src/invoice/payments/payments.test.tsx

@@ -64,15 +64,63 @@ describe('Payment', () => {
     expect(mockProcessBillPayment).toHaveBeenCalledTimes(1);
     expect(mockProcessBillPayment).toHaveBeenCalledWith(
       {
-        cashPoint: mockedActiveSheet.cashPoint.uuid,
-        cashier: mockedActiveSheet.cashier.uuid,
+        cashPoint: '65dd568e-4124-4e89-a4f8-0b07c58ec6fe',
+        cashier: '48b55692-e061-4ffa-b1f2-fd4aaf506224',
         lineItems: [
           {
-            billableService: 'Hemoglobin',
+            billableService: 'c15d25b9-12bb-441d-9241-cae541dd4575',
             display: 'BillLineItem',
-            item: 'Hemoglobin',
+            item: 'c15d25b9-12bb-441d-9241-cae541dd4575',
             lineItemOrder: 0,
+            order: null,
+            paymentStatus: 'PAID',
+            price: 500,
+            priceName: 'Default',
+            priceUuid: '',
+            quantity: 1,
+            resourceVersion: '1.8',
+            uuid: '314c25fd-2c90-4a7f-9f98-c99cd3f153e8',
+            voidReason: null,
+            voided: false,
+          },
+          {
+            billableService: '04be5832-5440-44d0-83d2-5c0dfd0ac7de',
+            display: 'BillLineItem',
+            item: '04be5832-5440-44d0-83d2-5c0dfd0ac7de',
+            lineItemOrder: 1,
+            order: null,
+            paymentStatus: 'PAID',
+            price: 100,
+            priceName: 'Default',
+            priceUuid: '',
+            quantity: 1,
+            resourceVersion: '1.8',
+            uuid: '60365e7e-d29e-4f13-b64b-9aecb5d36031',
+            voidReason: null,
+            voided: false,
+          },
+          {
+            billableService: '3f5d0684-a280-477e-a67b-2a956a1f6dca',
+            display: 'BillLineItem',
+            item: '3f5d0684-a280-477e-a67b-2a956a1f6dca',
+            lineItemOrder: 2,
+            order: null,
             paymentStatus: 'PAID',
+            price: 50,
+            priceName: 'Default',
+            priceUuid: '',
+            quantity: 1,
+            resourceVersion: '1.8',
+            uuid: '006ee634-f1cf-4552-b751-f721679527af',
+            voidReason: null,
+            voided: false,
+          },
+          {
+            billableService: null,
+            display: 'BillLineItem',
+            item: 'Hemoglobin',
+            lineItemOrder: 0,
+            paymentStatus: 'PENDING',
             price: 100,
             priceName: '',
             priceUuid: '',
@@ -85,14 +133,9 @@ describe('Payment', () => {
         ],
         patient: 'b2fcf02b-7ee3-4d16-a48f-576be2b103aa',
         payments: [
-          {
-            amount: 100,
-            amountTendered: 100,
-            attributes: [],
-            instanceType: '63eff7a4-6f82-43c4-a333-dbcc58fe9f74',
-          },
+          { amount: 100, amountTendered: 100, attributes: [], instanceType: '63eff7a4-6f82-43c4-a333-dbcc58fe9f74' },
         ],
-        status: 'PAID',
+        status: 'PENDING',
       },
       '6eb8d678-514d-46ad-9554-51e48d96d567',
     );

package/src/invoice/payments/utils.ts

@@ -70,6 +70,10 @@ export const determineBillableItemPaymentStatus = (
     return fallbackPaymentStatus;
   }
 
+  if (billableItem.paymentStatus === PaymentStatus.EXEMPTED) {
+    return PaymentStatus.EXEMPTED;
+  }
+
   const itemTotalCost = billableItem.price * billableItem.quantity;
   return totalPaidAmount >= itemTotalCost ? PaymentStatus.PAID : PaymentStatus.PENDING;
 };
@@ -133,16 +137,40 @@ export const createPaymentPayload = (
   const consolidatedPayments = [...currentPayments, ...existingPayments];
   const totalPaidAmount = consolidatedPayments.reduce((sum, payment) => sum + payment.amountTendered, 0);
 
-  // Process billable items
-  const processedLineItems = lineItems.map((lineItem) => ({
-    ...lineItem,
-    billableService: extractServiceIdentifier(lineItem),
-    item: extractServiceIdentifier(lineItem),
-    paymentStatus: isBillableItemInCollection(selectedBillableItems, lineItem)
-      ? determineBillableItemPaymentStatus(lineItems.length, lineItem, totalPaidAmount, initialPaymentStatus)
-      : isBillableItemFullyPaid(totalPaidAmount, lineItem),
+  // Process selected items and update their payment status
+  const processedSelectedBillableItems = selectedBillableItems.map((billableItem) => ({
+    ...billableItem,
+    billableService: extractServiceIdentifier(billableItem),
+    item: extractServiceIdentifier(billableItem),
+    paymentStatus: determineBillableItemPaymentStatus(
+      lineItems.length,
+      billableItem,
+      totalPaidAmount,
+      initialPaymentStatus,
+    ),
   }));
 
+  // Handle remaining line items based on whether there are selected items
+  const remainingLineItems =
+    selectedBillableItems.length > 0
+      ? // If items were selected, exclude them from the original line items
+        lineItems.filter((lineItem) => {
+          const isItemSelected = processedSelectedBillableItems.some(
+            (selectedItem) => selectedItem.uuid === lineItem.uuid,
+          );
+          return !isItemSelected;
+        })
+      : // If no items were selected, update payment status for all line items
+        lineItems.map((lineItem) => ({
+          ...lineItem,
+          billableService: extractServiceIdentifier(lineItem),
+          item: extractServiceIdentifier(lineItem),
+          paymentStatus: isBillableItemFullyPaid(totalPaidAmount, lineItem),
+        }));
+
+  // Combine selected and remaining items into final processed list
+  const processedLineItems = [...processedSelectedBillableItems, ...remainingLineItems];
+
   // Determine final bill status
   const hasUnpaidItems = processedLineItems.some((item) => item.paymentStatus === PaymentStatus.PENDING);
   const overallBillStatus = hasUnpaidItems ? PaymentStatus.PENDING : PaymentStatus.PAID;

package/src/prompt-payment/prompt-payment-modal.component.tsx

@@ -77,7 +77,7 @@ const PromptPaymentModal: React.FC<PromptPaymentModalProps> = () => {
             <StructuredListBody>
               {lineItems.map((lineItem) => {
                 return (
-                  <StructuredListRow>
+                  <StructuredListRow key={lineItem.uuid}>
                     <StructuredListCell>{extractString(lineItem.billableService || lineItem.item)}</StructuredListCell>
                     <StructuredListCell>{lineItem.quantity}</StructuredListCell>
                     <StructuredListCell>{convertToCurrency(lineItem.price)}</StructuredListCell>

package/src/prompt-payment/prompt-payment.modal.test.tsx

@@ -0,0 +1,200 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import PromptPaymentModal from './prompt-payment-modal.component';
+import { useBillingPrompt } from './prompt-payment.resource';
+import { navigate, useConfig } from '@openmrs/esm-framework';
+import { PaymentStatus } from '../types';
+import userEvent from '@testing-library/user-event';
+
+const mockNavigate = navigate as jest.MockedFunction<typeof navigate>;
+
+const mockMappedBill = [
+  {
+    uuid: '123e4567-e89b-12d3-a456-426614174000',
+    id: 1,
+    patientUuid: 'patient-uuid-123',
+    patientName: 'John Doe',
+    cashPointUuid: 'cashpoint-uuid-123',
+    cashPointName: 'Main Reception',
+    cashPointLocation: 'Hospital Wing A',
+    cashier: {
+      uuid: 'cashier-uuid-123',
+      display: 'Dr. Jane Smith',
+      links: [
+        {
+          rel: 'self',
+          uri: 'http://example.com/provider/cashier-uuid-123',
+          resourceAlias: 'provider',
+        },
+      ],
+    },
+    receiptNumber: 'REC-2023-001',
+    status: PaymentStatus.PENDING,
+    identifier: 'BILL-001',
+    dateCreated: '2023-08-15T10:30:00.000Z',
+    dateCreatedUnformatted: '2023-08-15',
+    lineItems: [
+      {
+        uuid: 'lineitem-uuid-123',
+        display: 'Consultation Fee',
+        voided: false,
+        voidReason: null,
+        item: 'Consultation',
+        billableService: 'some-uuid:General Consultation',
+        quantity: 1,
+        price: 50.0,
+        priceName: 'Standard Price',
+        priceUuid: 'price-uuid-123',
+        lineItemOrder: 1,
+        resourceVersion: '1.0',
+        paymentStatus: 'PENDING',
+        itemOrServiceConceptUuid: 'concept-uuid-123',
+        serviceTypeUuid: 'service-type-uuid-123',
+        order: {
+          uuid: 'order-uuid-123',
+        },
+      },
+    ],
+    billingService: 'Outpatient Services',
+    payments: [
+      {
+        uuid: 'payment-uuid-123',
+        instanceType: {
+          uuid: 'instance-type-uuid-123',
+          name: 'Cash Payment',
+          description: 'Standard cash payment',
+          retired: false,
+        },
+        attributes: [],
+        amount: 50.0,
+        amountTendered: 50.0,
+        dateCreated: 1692093000000, // Unix timestamp for 2023-08-15T10:30:00.000Z
+        voided: false,
+        resourceVersion: '1.0',
+      },
+    ],
+    totalAmount: 50.0,
+    tenderedAmount: 50.0,
+    display: 'Bill #BILL-001',
+    referenceCodes: 'REF-001',
+    adjustmentReason: undefined,
+  },
+];
+
+const mockUseBillingPrompt = useBillingPrompt as jest.MockedFunction<typeof useBillingPrompt>;
+const mockUseConfig = useConfig as jest.MockedFunction<typeof useConfig>;
+jest.mock('@openmrs/esm-patient-common-lib', () => ({
+  getPatientUuidFromStore: jest.fn(() => 'patient-uuid'),
+}));
+
+jest.mock('@openmrs/esm-framework', () => ({
+  useConfig: jest.fn(),
+  navigate: jest.fn(),
+}));
+
+jest.mock('./prompt-payment.resource', () => ({
+  useBillingPrompt: jest.fn(),
+}));
+
+describe('<PromptPaymentModal />', () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  test('should show the prompt payment modal, when `shouldShowBillingPrompt` is true and `enforceBillPayment` is true', async () => {
+    const user = userEvent.setup();
+    mockUseBillingPrompt.mockReturnValue({
+      shouldShowBillingPrompt: true,
+      isLoading: false,
+      bills: mockMappedBill,
+      currentVisit: null,
+      error: null,
+    });
+    mockUseConfig.mockReturnValue({
+      enforceBillPayment: true,
+    });
+    render(<PromptPaymentModal />);
+    expect(screen.getByText('Patient Billing Alert')).toBeInTheDocument();
+    expect(
+      screen.getByText('The current patient has pending bill. Advice patient to settle bill.'),
+    ).toBeInTheDocument();
+    expect(screen.getByText('Navigate back')).toBeInTheDocument();
+    // check if the structured list is rendered
+    const structuredListHeaders = ['Item', 'Quantity', 'Unit price', 'Total'];
+    structuredListHeaders.forEach((header) => {
+      expect(screen.getByText(header)).toBeInTheDocument();
+    });
+
+    // clicking cancel button should close the modal
+    const cancelButton = screen.getByText('Cancel');
+    await user.click(cancelButton);
+    expect(mockNavigate).toHaveBeenCalledWith({ to: `\${openmrsSpaBase}/home` });
+    // clicking proceed to care button should close the modal
+    const navigateBackButton = screen.getByText('Navigate back');
+    await user.click(navigateBackButton);
+    expect(mockNavigate).toHaveBeenCalledWith({ to: `\${openmrsSpaBase}/home` });
+  });
+
+  test('should show the prompt payment modal, when `shouldShowBillingPrompt` is true and `enforceBillPayment` is false and not navigate back', async () => {
+    const user = userEvent.setup();
+    mockUseBillingPrompt.mockReturnValue({
+      shouldShowBillingPrompt: true,
+      isLoading: false,
+      bills: mockMappedBill,
+      currentVisit: null,
+      error: null,
+    });
+    mockUseConfig.mockReturnValue({
+      enforceBillPayment: false,
+    });
+
+    render(<PromptPaymentModal />);
+    expect(screen.getByText('Patient Billing Alert')).toBeInTheDocument();
+    expect(
+      screen.getByText('The current patient has pending bill. Advice patient to settle bill.'),
+    ).toBeInTheDocument();
+    expect(screen.getByText('Cancel')).toBeInTheDocument();
+    expect(screen.getByText('Proceed to care')).toBeInTheDocument();
+
+    // clicking proceed to care button should close the modal
+    const proceedToCareButton = screen.getByText('Proceed to care');
+    await user.click(proceedToCareButton);
+    expect(mockNavigate).not.toHaveBeenCalled();
+
+    // clicking cancel button should close the modal
+    const cancelButton = screen.getByText('Cancel');
+    await user.click(cancelButton);
+    expect(mockNavigate).toHaveBeenCalledWith({ to: `\${openmrsSpaBase}/home` });
+  });
+
+  test('should show the loading state when `isLoading` is true', () => {
+    mockUseBillingPrompt.mockReturnValue({
+      shouldShowBillingPrompt: true,
+      isLoading: true,
+      bills: mockMappedBill,
+      currentVisit: null,
+      error: null,
+    });
+    mockUseConfig.mockReturnValue({
+      enforceBillPayment: true,
+    });
+    render(<PromptPaymentModal />);
+    expect(screen.getByText('Billing status')).toBeInTheDocument();
+    expect(screen.getByText('Verifying patient bills')).toBeInTheDocument();
+  });
+
+  test('should not render the modal when `shouldShowBillingPrompt` is false', () => {
+    mockUseBillingPrompt.mockReturnValue({
+      shouldShowBillingPrompt: false,
+      isLoading: false,
+      bills: mockMappedBill,
+      currentVisit: null,
+      error: null,
+    });
+    mockUseConfig.mockReturnValue({
+      enforceBillPayment: true,
+    });
+    render(<PromptPaymentModal />);
+    expect(screen.queryByText('Patient Billing Alert')).not.toBeInTheDocument();
+  });
+});