@openmrs/esm-fast-data-entry-app 1.0.0-pre.44 → 1.0.0-pre.48
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 +6 -7
- package/docs/configuring-form-categories.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,22 +2,21 @@
|
|
|
2
2
|
|
|
3
3
|
# OpenMRS ESM Fast Data Entry App
|
|
4
4
|
|
|
5
|
-
The Fast Data Entry App is a module for the (
|
|
5
|
+
The Fast Data Entry App is a module for the [OpenMRS](https://openmrs.org/) healthcare platform which allows for a natural workflow when entering many pre-recorded forms at a time. It is not meant for point-of-care workflows, but rather as a way to do retrospective data entry.
|
|
6
6
|
|
|
7
7
|
## Overview
|
|
8
8
|
Currently the app consists of two main parts, a Forms Page to list available forms and a Form Workflow which allows the rapid input of forms.
|
|
9
9
|
|
|
10
10
|
### Forms Page
|
|
11
|
-
The Forms page lists all forms able to be seen by a user, filtered by that user's permission to edit the given form. Additionally implementors are able to customize the page by creating form categories and listing the forms inside of each category. These categories can then be shown or hidden using configuration (see more (
|
|
11
|
+
The Forms page lists all forms able to be seen by a user, filtered by that user's permission to edit the given form. Additionally implementors are able to customize the page by creating form categories and listing the forms inside of each category. These categories can then be shown or hidden using configuration (see more [here](docs/configuring-form-categories.md)). From these lists forms are able to be opened in the Form Workflow using the 'Fill form' button.
|
|
12
12
|
|
|
13
13
|
### Form Workflow
|
|
14
|
-
Forms can be entered quickly with the Form Entry Workflow. This workflow depends on a state machine managed by the (
|
|
14
|
+
Forms can be entered quickly with the Form Entry Workflow. This workflow depends on a state machine managed by the [FormWorkflowReducer](src/context/FormWorkflowReducer.ts).
|
|
15
15
|
|
|
16
16
|
See the video below of a normal workflow.
|
|
17
|
-
!
|
|
18
|
-
|
|
17
|
+
|
|
19
18
|
State diagram for the Form Workflow.
|
|
20
|
-
!
|
|
19
|
+
|
|
21
20
|
|
|
22
21
|
## Running this code
|
|
23
22
|
|
|
@@ -28,7 +27,7 @@ yarn # to install dependencies
|
|
|
28
27
|
yarn start # to run the dev server
|
|
29
28
|
```
|
|
30
29
|
|
|
31
|
-
To customize your development build pass other arguments to yarn start (which under the hood is running `npx openmrs develop`). For example to point to a backend other than (
|
|
30
|
+
To customize your development build pass other arguments to yarn start (which under the hood is running `npx openmrs develop`). For example to point to a backend other than [dev3](https://dev3.openmrs.org/) specify the `--backend` option. See the full example below for running against an ICRC backend.
|
|
32
31
|
|
|
33
32
|
```sh
|
|
34
33
|
yarn start --importmap "https://spa-modules.nyc3.digitaloceanspaces.com/import-map.json" --backend "https://openmrs-dev-v2.test.icrc.org/" --add-cookie "MRHSession=abcdefghijklmnop012345678910" --spa-path "/ui"
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Configuring Form Categories for Fast Data Entry App
|
|
2
2
|
|
|
3
|
-
Configuration of which Form Categories to show, and which forms exist within each category is possible via configuration of Fast Data Entry App
|
|
3
|
+
Configuration of which Form Categories to show, and which forms exist within each category is possible via configuration of Fast Data Entry App [config-schema](../src/config-schema.ts). For example, the configuration would setup one category "ICRC Forms" which contains one form, DASS-21. Note that formUUID must match the form UUID on the backend instance, and name is only for human readability and has no actual function.
|
|
4
4
|
|
|
5
5
|
```json
|
|
6
6
|
{
|
|
@@ -25,7 +25,7 @@ Configuration of which Form Categories to show, and which forms exist within eac
|
|
|
25
25
|
|
|
26
26
|
This config results in the following UI:
|
|
27
27
|
|
|
28
|
-
!
|
|
28
|
+
|
|
29
29
|
|
|
30
30
|
Note that All Forms is always present and contains all forms the system can find.
|
|
31
31
|
|
|
@@ -71,7 +71,7 @@ Let's see another example. The following config will load up one more form categ
|
|
|
71
71
|
|
|
72
72
|
This will render the following UI
|
|
73
73
|
|
|
74
|
-
!
|
|
74
|
+
|
|
75
75
|
|
|
76
76
|
|
|
77
|
-
For more information on using the OpenMRS configuration system see
|
|
77
|
+
For more information on using the OpenMRS configuration system see [this page](https://o3-dev.docs.openmrs.org/#/main/config)
|