(feat) HSC-306: ERP billing status via widget #1

usamaidrsk · 2024-10-07T08:59:39Z

Requirements

This PR has a title that briefly describes the work done including a conventional commit type prefix and a Jira ticket number if applicable. See existing PR titles for inspiration.

For changes to apps

My work conforms to the OpenMRS 3.0 Styleguide and design documentation.

If applicable

My work includes tests or is validated by existing tests.

Summary

Description

This PR introduces a comprehensive configuration schema for the patient billing status module, providing flexible control over billing line conditions and system field mappings.

Key Changes

Introduced strongly-typed billing conditions with the following states:
- Order status (ORDER)
- Invoice status (INVOICED, NOT_INVOICED, FULLY_INVOICED, PARTIALLY_INVOICED)
- Payment status (PAID, NOT_PAID)
- Due date status (OVERDUE, NOT_OVERDUE)
- Cancellation status (CANCELLED)
Added configuration options for:
- Retire conditions: Define when billing lines should be removed from view
- Approval conditions: Specify combinations of states that indicate approved billing
- Non-approval conditions: Define state combinations that indicate pending/problematic billing
- Field mapping: Configure system field names for patient UUID and external order ID
Implemented validation logic to prevent conflicting condition states, such as:
- INVOICED vs NOT_INVOICED
- FULLY_INVOICED vs PARTIALLY_INVOICED
- PAID vs NOT_PAID
- OVERDUE vs NOT_OVERDUE

Configuration Example

{
  // Remove cancelled orders and fully invoiced orders from view
  retireLinesConditions: ['CANCELLED', 'ORDER,FULLY_INVOICED'],
  
  // Define non-approved states
  nonApprovedConditions: [
    'INVOICED,NOT_PAID',
    'ORDER,NOT_INVOICED',
    'INVOICED,OVERDUE,NOT_PAID'
  ],
  
  // Define approved states
  approvedConditions: [
    'INVOICED,PAID',
    'INVOICED,NOT_OVERDUE',
    'INVOICED,NOT_OVERDUE,PAID'
  ],
  
  // System field mappings
  patientUuidFieldName: 'partner_id',
  orderExternalIdFieldName: 'external_order_id'
}

Screenshots

Related Issue

https://mekomsolutions.atlassian.net/issues/HSC-306?filter=-1

Other

rbuisson · 2024-10-29T08:25:46Z

Thank you for the great documentation on PR description, make sure this is shown in the README too.
What's the behavior for grouping the orders? Is it per day?

(One cosmetic change: could you use the "outline" icons instead of "filled"?)

usamaidrsk · 2024-10-29T09:38:58Z

What's the behavior for grouping the orders? Is it per day?

Yes @rbuisson, grouping is by day.

usamaidrsk · 2024-10-29T11:37:24Z

(One cosmetic change: could you use the "outline" icons instead of "filled"?)

Hi @rbuisson
I have update the readme and used the outlined icons

rbuisson

LGTM. I let it to @vasharma05 to provide final approval.

vasharma05

A lot of comments for re-checking and a few suggestions. Missed out on translations too, but I am happy to see the great effort you put into this, great work @usamaidrsk 👏

vasharma05 · 2024-11-05T07:02:35Z

.github/workflows/e2e.yml

@@ -52,7 +52,7 @@ jobs:

      - name: Stop dev server
        if: "!cancelled()"
-        run: docker stop $(docker ps -a -q)
+        run: docker stop $(docker ps -a -q | xargs -r docker stop)


Did you add this referencing somewhere else?

vasharma05 · 2024-11-05T07:03:32Z

README.md

+    orderExternalIdFieldName: 'external_order_id'
+  }
+}
+```


Amazing 👏

vasharma05 · 2024-11-05T07:04:35Z

package.json

@@ -53,6 +54,7 @@
  },
  "devDependencies": {
    "@openmrs/esm-framework": "next",
+    "@openmrs/esm-patient-common-lib": "next",


@usamaidrsk, do bump the framework and common lib in this PR again. Thanks!

package.json

vasharma05 · 2024-11-05T07:06:20Z

src/components/billing-status-summary.component.tsx

+  const isTablet = layout === 'tablet';
+  const isDesktop = layout === 'small-desktop' || layout === 'large-desktop';


Since we don't support phone layout, we can assume that isDesktop = !isTablet

src/resources/billing-status.resource.ts

vasharma05 · 2024-11-05T07:26:07Z

src/resources/billing-status.resource.ts

+    const [orders, invoices] = await Promise.all([
+      fetchOrders(patientUuid, config),
+      fetchInvoices(patientUuid, config),
+      //   TODO fetch patient visits fetchVisits(patientUuid)
+    ]);
+    return processBillingLines(orders, invoices, config);


We can do all of this using SWR too, let's use SWR for data fetching.

You can write SWR hooks for each fetching, and final billingLines will be calculated/ processed once all the data is present. All these requests will go parallel in this scenario too, and you don't have to handle promises

vasharma05 · 2024-11-05T07:30:47Z

src/resources/billing-status.resource.ts

+  return response.data;
+};
+
+const fetchInvoices = async (patientUuid: string, config: Config) => {


Fetch all these using SWR, have added a suggestion elsewhere.

vasharma05 · 2024-11-05T07:31:50Z

src/root.component.tsx

-      <Resources />
-    </div>
-  );
+  return <div>root</div>;
 };

 export default Root;


We can remove this file altogether, if we are not using this

vasharma05 · 2024-11-05T07:32:07Z

src/root.test.tsx

-  expect(screen.getByRole('heading', { name: /data fetching/i })).toBeInTheDocument();
-  expect(screen.getByRole('heading', { name: /resources/i })).toBeInTheDocument();
-  expect(screen.getByRole('button', { name: /get a patient named 'test'/i })).toBeInTheDocument();
+  expect(screen.getByText('root')).toBeInTheDocument();
 });


This file too

vasharma05

Few changes, else good to go!
Thanks @usamaidrsk for the great work!

vasharma05 · 2024-11-06T10:27:53Z

src/index.ts

-export const blueBox = getAsyncLifecycle(() => import('./boxes/extensions/blue-box.component'), options);
-
-export const brandBox = getAsyncLifecycle(() => import('./boxes/extensions/brand-box.component'), options);
+export const patientBillingStatusOverview = getSyncLifecycle(patientBillingStatusSummary, options);


This should be async. The only items meant to be sync are the dashboard links and icon buttons which navigate to other pages.

vasharma05 · 2024-11-06T10:29:38Z

src/resources/billing-status.resource.ts

+            startDate: visit.startDatetime,
+            endDate: visit.stopDatetime,


Don't we need to use the order's datetime it was placed and the endDatetime?

Why are we fetching all the visits?

Yes we do need all visits to group the orders in each visit. Though this is not working at he moment, I just left the code if we intend to group by visits someday

vasharma05 · 2024-11-06T10:31:06Z

src/resources/billing-status.resource.ts

+        tags.push(BillingCondition.NOT_OVERDUE);
+      }
+
+      let orderId = ''; // TODO this should be the orderExternalId of the invoice order


Is this TODO still pending?

Yeah, it is still pending

usamaidrsk added 8 commits October 3, 2024 10:05

(chore) update README.md

ee3efeb

(chore) update esm name

a90c4e0

(chore) up the framework

84f72f0

(chore) cleanup initial setup

67816fd

(chore) ignore idea files

a6c3167

(chore) add es2022 lib

b0fe32a

(feat) create billing status component

766089e

(fix) fix table sizing

4b9bed8

usamaidrsk self-assigned this Oct 7, 2024

usamaidrsk added 4 commits October 21, 2024 20:29

add backend dependecie erp

067ad19

feat: add visit grouping for lines

4eef0d1

(feat) improve the config-schema.ts

dbe5aab

(feat) display orders and invoices by day

e531b00

usamaidrsk force-pushed the ft-HSC-306 branch from 80f4246 to e531b00 Compare October 28, 2024 16:22

usamaidrsk added 2 commits October 28, 2024 21:59

feat: add tests

1d4d29e

feat: disable e2e

685e394

usamaidrsk requested review from rbuisson and vasharma05 October 28, 2024 19:14

usamaidrsk added 3 commits October 28, 2024 22:20

(fix) fix lockfile

1b3e6b6

fix: fix build:

4943d89

fix: fix tests

d80d9ad

usamaidrsk closed this Oct 29, 2024

usamaidrsk reopened this Oct 29, 2024

update readme

cca1290

rbuisson approved these changes Oct 30, 2024

View reviewed changes

vasharma05 reviewed Nov 5, 2024

View reviewed changes

use useWSR on fetching

1ed891b

usamaidrsk added 2 commits November 6, 2024 07:35

bump common-libs

839e6d4

chore: add more tests

3d9f51a

usamaidrsk requested a review from vasharma05 November 6, 2024 06:17

usamaidrsk added 3 commits November 6, 2024 09:23

remove dummy files

d53d301

bump patient-common-lib

7871530

fix tests

bc90be1

vasharma05 approved these changes Nov 6, 2024

View reviewed changes

use getAsyncLifecycl

77b696c

usamaidrsk merged commit 572ee8c into main Nov 6, 2024
4 of 5 checks passed

This was referenced Nov 8, 2024

(feat) HSC-306: ERP billing status via widget mekomsolutions/openmrs-esm-patient-billing-status-app#1

Merged

Ft hsc 306 mekomsolutions/openmrs-esm-patient-billing-status-app#3

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(feat) HSC-306: ERP billing status via widget #1

(feat) HSC-306: ERP billing status via widget #1

usamaidrsk commented Oct 7, 2024 •

edited

Loading

rbuisson commented Oct 29, 2024

usamaidrsk commented Oct 29, 2024

usamaidrsk commented Oct 29, 2024

rbuisson left a comment

vasharma05 left a comment

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 Nov 5, 2024

vasharma05 left a comment

vasharma05 Nov 6, 2024

vasharma05 Nov 6, 2024

vasharma05 Nov 6, 2024

usamaidrsk Nov 6, 2024

vasharma05 Nov 6, 2024

usamaidrsk Nov 6, 2024

		const isTablet = layout === 'tablet';
		const isDesktop = layout === 'small-desktop' \|\| layout === 'large-desktop';

(feat) HSC-306: ERP billing status via widget #1

(feat) HSC-306: ERP billing status via widget #1

Conversation

usamaidrsk commented Oct 7, 2024 • edited Loading

Requirements

For changes to apps

If applicable

Summary

Description

Key Changes

Configuration Example

Screenshots

Related Issue

Other

rbuisson commented Oct 29, 2024

usamaidrsk commented Oct 29, 2024

usamaidrsk commented Oct 29, 2024

rbuisson left a comment

Choose a reason for hiding this comment

vasharma05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vasharma05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

usamaidrsk commented Oct 7, 2024 •

edited

Loading