@openmrs/esm-billing-app 1.0.2-pre.307 → 1.0.2-pre.308
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -6
- package/dist/routes.json +1 -1
- package/e2e/specs/sample-test.spec.ts +0 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,24 @@
|
|
|
1
1
|
# OpenMRS 3.x Billing ESM
|
|
2
2
|
|
|
3
|
+

|
|
4
|
+
|
|
3
5
|
The OpenMRS Billing Module is designed to streamline the financial operations within healthcare settings by facilitating the management of patient billing, payments, and service pricing. This module integrates seamlessly with the OpenMRS platform, allowing healthcare providers to generate bills, track payments, and manage various billable services. It is an essential tool for ensuring transparency and accuracy in financial transactions within healthcare facilities, contributing to efficient service delivery.
|
|
4
6
|
|
|
7
|
+
The **Billing ESM** is a microfrontend for OpenMRS 3.x designed to manage healthcare billing workflows. It allows users to:
|
|
8
|
+
|
|
9
|
+
- Generate and manage bills
|
|
10
|
+
- Capture payments and insurance details
|
|
11
|
+
- Configure billable services and categories
|
|
12
|
+
- Integrate with visits and patient dashboards
|
|
13
|
+
|
|
5
14
|
Dependency: Note that this frontend module depends on the backend module called "Billing Module": https://github.com/openmrs/openmrs-module-billing
|
|
6
15
|
|
|
7
16
|
For more information, please see the
|
|
8
|
-
[OpenMRS Frontend Developer Documentation](https://
|
|
17
|
+
[OpenMRS Frontend Developer Documentation](https://openmrs.atlassian.net/wiki/x/IABBHg).
|
|
9
18
|
|
|
10
19
|
## Local development
|
|
11
20
|
|
|
12
|
-
Check out the developer documentation [here](
|
|
21
|
+
Check out the developer documentation [here](https://openmrs.atlassian.net/wiki/x/IABBHg).
|
|
13
22
|
|
|
14
23
|
This monorepo uses [yarn](https://yarnpkg.com).
|
|
15
24
|
|
|
@@ -75,12 +84,42 @@ To run end-to-end tests, run:
|
|
|
75
84
|
yarn test-e2e
|
|
76
85
|
```
|
|
77
86
|
|
|
78
|
-
Read the [e2e testing guide](https://
|
|
87
|
+
Read the [e2e testing guide](https://openmrs.atlassian.net/wiki/x/Z8CEAQ) to learn more about End-to-End tests in this project.
|
|
79
88
|
|
|
80
89
|
### Updating Playwright
|
|
81
90
|
|
|
82
91
|
The Playwright version in the [Bamboo e2e Dockerfile](e2e/support/bamboo/playwright.Dockerfile#L2) and the `package.json` file must match. If you update the Playwright version in one place, you must update it in the other.
|
|
83
92
|
|
|
93
|
+
## ⚙️ Configuration
|
|
94
|
+
|
|
95
|
+
You can customize billing behavior using OpenMRS frontend config overrides.
|
|
96
|
+
### 🔧 Example Config
|
|
97
|
+
|
|
98
|
+
``` bash
|
|
99
|
+
{
|
|
100
|
+
"openmrs": {
|
|
101
|
+
"config": {
|
|
102
|
+
"billing": {
|
|
103
|
+
"defaultCurrency": "UGX",
|
|
104
|
+
"pageSize": 20,
|
|
105
|
+
"showEditBillButton": true,
|
|
106
|
+
"patientCatergory": {
|
|
107
|
+
"paymentDetails": "fbc0702d-...",
|
|
108
|
+
"insuranceScheme": "aac48226-..."
|
|
109
|
+
},
|
|
110
|
+
"nonPayingPatientCategories": {
|
|
111
|
+
"childUnder5": "1528AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
```
|
|
118
|
+
``` bash
|
|
119
|
+
📌 Ensure all UUIDs used here exist in your OpenMRS instance.
|
|
120
|
+
🧩 Configuration can be managed via your MF shell app or import-map-deployer
|
|
121
|
+
```
|
|
122
|
+
|
|
84
123
|
## Troubleshooting
|
|
85
124
|
|
|
86
125
|
If you notice that your local version of the application is not working or that there's a mismatch between what you see locally versus what's in [dev3](https://dev3.openmrs.org/openmrs/spa), you likely have outdated versions of core libraries. To update core libraries, run the following commands:
|
|
@@ -99,7 +138,6 @@ git checkout package.json
|
|
|
99
138
|
```bash
|
|
100
139
|
yarn
|
|
101
140
|
```
|
|
102
|
-
|
|
103
141
|
## Design Patterns
|
|
104
142
|
|
|
105
143
|
For documentation about our design patterns, please visit our [design system](https://zeroheight.com/23a080e38/p/880723--introduction) documentation website.
|
|
@@ -110,8 +148,10 @@ Please see the [Implementer Documentation](https://wiki.openmrs.org/pages/viewpa
|
|
|
110
148
|
|
|
111
149
|
## Deployment
|
|
112
150
|
|
|
113
|
-
See [Creating a Distribution](
|
|
151
|
+
See [Creating a Distribution](https://openmrs.atlassian.net/wiki/x/IABBHg) for information about adding microfrontends to a distribution.
|
|
114
152
|
|
|
115
153
|
## Contributing
|
|
116
154
|
|
|
117
|
-
For more information on how to get started, please refer to [OpenMRS Frontend Developer Documentation](https://
|
|
155
|
+
For more information on how to get started, please refer to [OpenMRS Frontend Developer Documentation](https://openmrs.atlassian.net/wiki/x/94ABCQ).
|
|
156
|
+
|
|
157
|
+
Detailed documentation on Billing Module can be found [here](https://openmrs.atlassian.net/wiki/x/0w2bAQ)
|
package/dist/routes.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"$schema":"https://json.openmrs.org/routes.schema.json","backendDependencies":{"webservices.rest":">=2.24.0","fhir2":">=1.2"},"pages":[{"component":"billableServicesHome","route":"billable-services"}],"extensions":[{"component":"billingDashboardLink","name":"billing-dashboard-link","slot":"homepage-dashboard-slot","meta":{"name":"billing","title":"billing","slot":"billing-dashboard-slot"},"featureFlag":"billing"},{"component":"root","name":"billing-dashboard-root","slot":"billing-dashboard-slot"},{"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 history"},"featureFlag":"billing"},{"name":"billable-services-app-menu-item","component":"billableServicesAppMenuItem","slot":"app-menu-item-slot","meta":{"name":"Billable Services"}},{"name":"billing-checkin-form","slot":"extra-visit-attribute-slot","component":"billingCheckInForm","featureFlag":"billing"},{"slot":"system-admin-page-card-link-slot","component":"billableServicesCardLink","name":"billable-services-admin-card-link"},{"name":"patient-banner-billing-tags","component":"visitAttributeTags","slot":"patient-banner-tags-slot","order":2},{"name":"billing-home-tiles-ext","slot":"billing-home-tiles-slot","component":"serviceMetrics"},{"name":"edit-bill-line-item-dialog","component":"editBillLineItemDialog","online":true,"offline":true}],"modals":[{"name":"require-billing-modal","component":"requirePaymentModal"}],"workspaces":[{"name":"billing-form-workspace","title":"billingForm","component":"billingFormWorkspace","type":"form"}],"featureFlags":[{"flagName":"billing","label":"Billing module","description":"This feature introduces navigation links on the patient chart and home page to allow accessing the billing module features"}],"version":"1.0.2-pre.
|
|
1
|
+
{"$schema":"https://json.openmrs.org/routes.schema.json","backendDependencies":{"webservices.rest":">=2.24.0","fhir2":">=1.2"},"pages":[{"component":"billableServicesHome","route":"billable-services"}],"extensions":[{"component":"billingDashboardLink","name":"billing-dashboard-link","slot":"homepage-dashboard-slot","meta":{"name":"billing","title":"billing","slot":"billing-dashboard-slot"},"featureFlag":"billing"},{"component":"root","name":"billing-dashboard-root","slot":"billing-dashboard-slot"},{"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 history"},"featureFlag":"billing"},{"name":"billable-services-app-menu-item","component":"billableServicesAppMenuItem","slot":"app-menu-item-slot","meta":{"name":"Billable Services"}},{"name":"billing-checkin-form","slot":"extra-visit-attribute-slot","component":"billingCheckInForm","featureFlag":"billing"},{"slot":"system-admin-page-card-link-slot","component":"billableServicesCardLink","name":"billable-services-admin-card-link"},{"name":"patient-banner-billing-tags","component":"visitAttributeTags","slot":"patient-banner-tags-slot","order":2},{"name":"billing-home-tiles-ext","slot":"billing-home-tiles-slot","component":"serviceMetrics"},{"name":"edit-bill-line-item-dialog","component":"editBillLineItemDialog","online":true,"offline":true}],"modals":[{"name":"require-billing-modal","component":"requirePaymentModal"}],"workspaces":[{"name":"billing-form-workspace","title":"billingForm","component":"billingFormWorkspace","type":"form"}],"featureFlags":[{"flagName":"billing","label":"Billing module","description":"This feature introduces navigation links on the patient chart and home page to allow accessing the billing module features"}],"version":"1.0.2-pre.308"}
|
package/package.json
CHANGED