Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [DHIS2-13800] ask user to complete enrollment and events #3548

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 34 additions & 23 deletions docs/user/using-the-capture-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -978,6 +978,12 @@ You can delete the enrollment by clicking the delete button and confirming the a

![](resources/images/enrollment-dash-enrollment-widget-3.png)

#### Complete the enrollment

You can complete the enrollment by clicking the complete button. When there are active events, you can choose to complete the enrollment along with the events from the confirmation modal.

![](resources/images/enrollment-dash-enrollment-widget-4.png)

#### Enrollment comment widget

![](resources/images/enrollment-widget-comment.png)
Expand Down Expand Up @@ -1114,10 +1120,6 @@ To go to Enrollment Overview page you can:

![](resources/images/enrollment-event-new-navigation.png)

### New event widget form
This is the form where you can modify the event details before saving. In the header you can see the stage name and icon.
![](resources/images/new-event-widget-form-header.png)


### Scheduled date in edit event form
If an event has the status Scheduled or Overdue, you will be able to see the **Report** and **Schedule** tab.
Expand All @@ -1140,6 +1142,10 @@ If the flag “Hide due date” in the Maintenance configuration is enabled, sch
However, you can still schedule an event, but it automatically chooses the date based on "Scheduled days from start" that has been configured in Maintenance, and this can not be changed.
In the **Schedule** tab, there will be “Schedule info” saying “Scheduled automatically for xx/xx/xx”, and the user can click **Schedule** button.

### Ask user to complete program when stage is complete
If this flag has been enabled for the stage in Stage details in Maintenance, a modal will show up after the user checks the **Complete** event checkbox and clicks save.

![](resources/images/ask-user-to-complete-enrollment-edit-event.png)

#### View mode

Expand All @@ -1163,9 +1169,24 @@ In this form you can also delete the event by clicking `Delete` button, a modal

The widgets seen in the right-hand column will display and function the same way as mentioned in the [enrollment dashboard](#enrollment-dashboard).

##### Widget assignee
1. In View/Edit enrollment event page

2. In the right column you will find the assignee widget.

![](resources/images/user_assignment_edit_enrollment.png)

3. Click the **Edit** button, or the **Assign** button if the event is not currently assigned to anyone.

![](resources/images/user_assignment_edit_button.png)

![](resources/images/user_assignment_edit_add.png)

4. Search for and select the user you would like to reassign the event to. Click the **Save** button.

![](resources/images/enrollment-event-view-edit-widgets.png)

## Add event in enrollment page
## Enrollment event new page

You can reach this page add event page by clicking in the **New {stage event name}** button in the overview page.
In this page you can switch between different tabs: **Report** to add new event, **Schedule** to schedule an event and **Refer** to refer event.
Expand All @@ -1185,13 +1206,14 @@ To navigate back to the enrollment overview, click the **Cancel without saving**

![](resources/images/enrollment-event-new-stage-selection-list.png)

### Ask user to complete program when stage is complete
If this flag has been enabled for the stage in Stage details in Maintenance, a modal will show up after the user clicks the **Complete** button.

![](resources/images/ask-user-to-complete-enrollment-new-event.png)

### Ask user to create new event when stage is complete
If this flag has been enabled for the stage in Stage details in Maintenance, a modal will show up after the user clicks the **Complete** button or checks the **Complete** event checkbox and clicks save. The user can choose the button **Yes, create new event** to navigate to the New Event page or **No, cancel** to navigate back to the enrollment dashboard. If there is only one possible stage available, the user will be taken directly to the New event workspace for that stage.

### Schedule event widget form
Instead of reporting an event the user can select to schedule an event for later. The form will open with a suggested scheduled date. This date is determined by a set of rules as explained below.

The suggested date for the first event of a program stage in an enrollment is always based on the enrollment date or the incident date (depending on the program configuration). The program stage configuration setting "scheduled days from start" will be added to the base date to cumpute the suggested date.

### Assigning user to new events
When reporting or scheduling an event, you can assign a user to it. This feature must be enabled per program stage in a tracker program by clicking the "Allow user assignment of events" check box.
Expand All @@ -1202,21 +1224,10 @@ You will find the assignee section near the bottom of the data entry page. Searc

![](resources/images/user_assignment_schedule_new_filled.png)

### Change assignee
1. In View/Edit enrollment event page

2. In the right column you will find the assignee widget.

![](resources/images/user_assignment_edit_enrollment.png)

3. Click the **Edit** button, or the **Assign** button if the event is not currently assigned to anyone.

![](resources/images/user_assignment_edit_button.png)

![](resources/images/user_assignment_edit_add.png)

4. Search for and select the user you would like to reassign the event to. Click the **Save** button.
### Schedule event widget form
Instead of reporting an event the user can select to schedule an event for later. The form will open with a suggested scheduled date. This date is determined by a set of rules as explained below.

The suggested date for the first event of a program stage in an enrollment is always based on the enrollment date or the incident date (depending on the program configuration). The program stage configuration setting "scheduled days from start" will be added to the base date to cumpute the suggested date.

#### 1. **Default next scheduled date**
If a program stage has a default next scheduled date configured, the suggested date is the most recent next scheduled date. Below is an example of how this can work.
Expand Down
Loading