BIP Update Current Progress
1. What does this feature do? (High-Level Overview)
Section titled “1. What does this feature do? (High-Level Overview)”This feature updates plan-level current progress in bulk for a selected date range and selected BIP categories, so clinical teams can keep goal progress synchronized without editing each plan one by one. It improves operational speed and consistency when multiple plans need progress refresh at the same time.
2. Who is this for? (Roles & Permissions)
Section titled “2. Who is this for? (Roles & Permissions)”- Superadmin/Admin/Owner/Manager (or any role granted manage_bips): Primary users of editable tabbed BIP flow; can execute Update Current Progress from the BIP header action.
- RBT/Analyst without manage_bips: Usually redirected to full BIP read-only flow and do not use this tabbed update workflow.
- Users without BIP access permissions (view_bips/manage_bips): Cannot access BIP actions from normal client workflows.
Required permissions used by this feature path:
- manage_bips: Required to remain in editable tabbed BIP route where this action is exposed.
- view_bips: Used in non-tabbed BIP viewing entry points.
3. Business Rules & Enforcements
Section titled “3. Business Rules & Enforcements”- Rule 1: Action is launched from BIP tabbed header button Update Current Progress.
- Rule 2: Modal requires at least one category selected.
- Rule 3: Modal requires both Start Date and End Date.
- Rule 4: Start Date and End Date cannot be equal.
- Rule 5: Start Date must be earlier than End Date.
- Rule 6: Backend update call requires persisted BIP ID; operation is blocked if BIP ID is missing.
- Rule 7: During update request, a loading modal is shown and closed on success or error.
- Rule 8: On success, returned BIP data replaces local BIP state and notifies current-progress listeners.
- Rule 9: If backend returns omitted plans, system groups them by UI category and opens omitted-plan selector flow before final success confirmation.
- Rule 10: On failure, user receives explicit error feedback with backend message when available.
Default category set used in the modal:
- maladaptives
- replacements
- rbt_trainings
- caregiver_trainings
- teacher_trainings
4. UI Placement
Section titled “4. UI Placement”- Medical > clients list > client actions > BIP View / Update.
- Inside BIP tabbed header actions: Update Current Progress button.
- Triggered modal: Update Current Progress (date range + category checkboxes).
- Route family used for tabbed BIP: /bip/tabbed/:patient_id and /:id route variant under BIP module.
5. How-To Guide (Step-by-Step)
Section titled “5. How-To Guide (Step-by-Step)”Scenario A: Update progress for selected categories
Section titled “Scenario A: Update progress for selected categories”- Go to Medical and open the client list.
- Open client actions and click BIP View / Update.
- In header actions, click Update Current Progress.
- Set Start Date and End Date.
- Select categories to include.
- Click Update.
- Review success message and verify refreshed current progress in plans.
Scenario B: Handle omitted plans after update
Section titled “Scenario B: Handle omitted plans after update”- Run Update Current Progress with selected categories.
- If system detects omitted plans, review omitted-plan selector dialog.
- Confirm and close dialog.
- Verify final success message and updated records.
Scenario C: Validation failure in modal
Section titled “Scenario C: Validation failure in modal”- Open Update Current Progress modal.
- Leave missing/invalid fields (no categories, missing dates, equal dates, or inverted range).
- Click Update.
- System blocks submission and shows validation warning/error.
6. What happens if…? (Edge Cases / FAQ)
Section titled “6. What happens if…? (Edge Cases / FAQ)”-
Q: What happens if BIP ID is missing?
-
A: Update is blocked and system shows BIP ID required error.
-
Q: What happens if backend cannot update current progress?
-
A: Loading modal closes and user gets error message with backend detail when available.
-
Q: What happens if some plans are omitted in the selected categories?
-
A: System opens omitted-plan dialog flow grouped by category before final completion messaging.