Bulk Objectives Creation

1. What does this feature do? (High-Level Overview)

This feature lets users create multiple Short-Term Objectives (STOs) in one action and optionally create or replace the Long-Term Objective (LTO) in the same workflow. Users can generate STOs either by entering the number of objectives they want or by entering an interval value and letting the application calculate how many STOs are needed. It reduces manual setup time and keeps objective wording and progression consistent across a plan.

This is a supporting workflow inside plan details, not a separate BIP tab.

2. Who is this for? (Roles & Permissions)

• Users with BIP edit access (manage_bips): Can open the bulk generator, generate proposals, create STOs, and optionally replace the plan LTO.
• Product Owner, Stakeholders, and Project Manager: Can use this guide to understand expected behavior, constraints, and review flow.

3. Business Rules & Enforcements

• Rule 1: The workflow is opened from plan detail using Create objectives in bulk.
• Rule 2: The flow always requires STO generation.
• Rule 3: The user can choose one of two STO generation methods:
  • Number of objectives
  • Interval value
• Rule 4: In Number of objectives mode, the user must enter at least 1 objective.
• Rule 5: In Interval mode, the user must enter a whole-number interval of at least 1.
• Rule 6: The user must enter both Start point and Final target, and they cannot be equal.
• Rule 7: STO consecutive weeks must be between 1 and 12 (default is 4 in the form).
• Rule 8: The comparison operator is constrained by direction:
  • Increase allows > or >=.
  • Decrease allows < or <=.
• Rule 9: In Interval mode, the system creates one STO per interval step and automatically calculates the number of objectives needed to reach the final target.
• Rule 10: In Interval mode, the last STO may be shorter than the interval if that is required to land exactly on the final target.
• Rule 11: Proposal generation is mandatory before creation. Creation is blocked until proposal is generated and Add/Replace is selected.
• Rule 12: The modal uses a two-step flow:
  • Step 1: Input form.
  • Step 2: Proposal review with Back to edit available.
• Rule 13: Users can optionally enable Also create LTO.
• Rule 14: If LTO creation is enabled:
  • LTO uses category-specific templates.
  • LTO weeks are separate from STO weeks (default 12, range 1-12).
  • LTO Start point and Target are set to the same value (the final STO target).
  • LTO uses the same comparison operator selected for STOs.
• Rule 15: If a plan already has an LTO and user enables LTO creation, the UI shows a warning that the existing LTO will be replaced.
• Rule 16: On submit, replace=true only replaces existing STOs. It does not control LTO replacement.
• Rule 17: If LTO payload is included, backend replaces existing LTO with the new one, keeping only one active LTO in the plan.
• Rule 18: New objectives created through this flow default to Not Started.
• Rule 19: If any objective in the bulk transaction fails validation, the full operation is rolled back (no partial creation).

4. UI Placement

1. Patient Record > BIP: Open the patient’s BIP.
2. Choose a plan tab: Open Maladaptives, Replacements, RBT Training Plans, or Caregiver Training Plans.
3. Open a specific plan: Enter the plan detail view.
4. Objectives area: Use the button Create objectives in bulk.

5. How-To Guide (Step-by-Step)

Scenario A: Create STOs in bulk and keep current LTO

1. Open the patient BIP and enter the correct plan.
2. In the plan detail view, select Create objectives in bulk.
3. Leave Use interval instead of objective count turned off.
4. Enter the number of objectives you want to create.
5. Choose the template you want to use.
6. Enter the Start point and the Final target.
7. Enter the number of consecutive weeks to complete.
8. Review the comparison operator suggested by the application and adjust it if needed.
9. Leave Also create LTO unchecked.
10. Select Generate proposal.
11. In the proposal step, review generated STOs.
12. Choose whether to add to existing STOs or replace existing STOs.
13. Select Create.

Scenario B: Create STOs using interval mode

1. Open the patient BIP and enter the correct plan.
2. In the plan detail view, select Create objectives in bulk.
3. Turn on Use interval instead of objective count.
4. Enter the interval value.
5. Review the read-only Calculated objectives field.
6. Choose the template you want to use.
7. Enter the Start point and the Final target.
8. Enter the number of consecutive weeks to complete.
9. Review the comparison operator suggested by the application and adjust it if needed.
10. Select Generate proposal.
11. In the proposal step, review the generated chained STO ranges.
12. Choose whether to add to existing STOs or replace existing STOs.
13. Select Create.

Scenario C: Create STOs and replace current LTO in one action

1. Open the bulk creation dialog from the plan detail view.
2. Choose either Number of objectives mode or Interval mode.
3. Choose the template you want to use.
4. Enter the Start point and the Final target.
5. Enter the number of consecutive weeks to complete.
6. Review the comparison operator suggested by the application and adjust it if needed.
7. Enable Also create LTO.
8. Choose an LTO template and set LTO consecutive weeks.
9. If needed, use Generate proposal, then Back to edit to adjust values and regenerate.
10. In the proposal step, review both STO and LTO proposal rows.
11. Choose STO add/replace mode.
12. Select Create.
13. Confirm in plan details that the new STO sequence is present and the previous LTO has been replaced.

6. What happens if…? (Edge Cases / FAQ)

• Q: What happens if the Start point and Final target are equal?
  • A: The application does not generate the proposal. The user must enter values that show either improvement or reduction.
• Q: Can interval mode work for both increasing and decreasing targets?
  • A: Yes. The application adds the interval when the final target is higher than the start point and subtracts the interval when the final target is lower.
• Q: What happens if the remaining distance is smaller than the selected interval?
  • A: The application creates a final STO that ends exactly at the target, even if the last step is shorter than the interval.
• Q: Can the user create objectives without reviewing a proposal first?
  • A: No. The Create action is only enabled in the proposal step after generation.
• Q: Can the user edit values after seeing the proposal?
  • A: Yes. The Back to edit button returns to the form so values can be updated and a new proposal can be generated.
• Q: Does selecting STO replace mode also replace LTO?
  • A: No. STO replace mode affects STOs only. LTO replacement is controlled only by enabling Also create LTO.
• Q: What if the plan already has an LTO and the user enables LTO creation?
  • A: The modal warns that the current LTO will be replaced, and backend enforces a single active LTO.
• Q: Can this flow create only an LTO without STOs?
  • A: No. This workflow requires STO generation (minimum of one STO).
• Q: What happens if validation fails for one objective in the request?
  • A: The whole operation is rejected and rolled back; no partial objectives are saved.