BIP Checker

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

The BIP Checker gives staff a quick quality review of a Behavior Intervention Plan before they continue editing, review the full document, or export it. It helps catch missing information, inconsistent plan content, and sections that may be outdated so the BIP is easier to review and maintain.

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

Superadmin: Can access and run the checker when they can enter the editable BIP experience.
Admin: Can access and run the checker through the editable BIP experience.
Owner: Can access and run the checker when they have the required editing permission for BIPs.
Manager: Can access and run the checker when they have the required editing permission for BIPs.
RBT/Analyst: Analysts such as BCBAs can use the checker when they have the required editing permission for BIPs. RBT users who only have view access do not see the checker.

Required permission:

manage_bips: Required to see the editable BIP screen and use Run BIP Checker.
view_bips: Allows read-only BIP access, but does not show the checker.

3. Business Rules & Enforcements

Rule 1: The checker reviews whether the BIP has the core information expected in a complete plan, including patient identification, contact details, report ownership, report dates, treatment history, current status, strengths, needs, goals, interventions, crisis planning, consent, and supporting documentation.
Rule 2: Some checks only apply when they are relevant. For example, medication details are only expected when medication tracking applies, reevaluations are expected to include progress graphs, and school-service sections are expected when school services are being used.
Rule 3: The checker can apply insurance-specific review rules when they exist for the patient. If no insurance-specific version exists, it falls back to the standard review rules.
Rule 4: The checker flags behavior plans that look duplicated or overlapping so reviewers can confirm the BIP is not tracking nearly identical targets under separate names.
Rule 5: New replacement plans are expected to show real maintenance progress, not just newly added content without a maintained short-term objective.
Rule 6: The review expects at least one intervention to have been added during the selected report period so the plan reflects current work.
Rule 7: An intervention cannot appear to start before the objective it is supposed to support.
Rule 8: Short-term objectives that are still in progress should generally be recent. At least 80% of in-progress STOs are expected to have started within the last 5 months and to remain open without an end date; otherwise, the checker flags that the plan may need updating, unless there is already a long-term objective actively in progress.
Rule 9: A target plan should not remain active when all of its STO and LTO objectives are already marked as mastered and the LTO end date falls before the start of the selected report window.
Rule 10: Every active plan is expected to have at least one active objective still in progress.
Rule 11: Goals that are still in progress or not started are expected to include clear measurement details so staff know the starting point, target, and expected time to complete them.
Rule 12: The checker also warns when important BIP sections have not been updated recently. This is a warning, not an automatic block.
Rule 13: The checker warns when plan progress fields have not been refreshed recently for maladaptive, replacement, caregiver training, RBT training, or teacher training plans.
Rule 14: The checker flags active target plans when a short-term objective stays unmastered more than 12 weeks after the latest plan activation. STOs that were already mastered before that activation are ignored, and when a plan has multiple activation events the latest one is the one that counts.
Rule 15: The checker warns when the consent section is missing at least one analyst signature.
Rule 16: The frontend shows results as guidance only. It does not block editing, exporting, or other actions by itself.

Recent-update warnings currently cover these BIP sections:

Documents and Results: Warns after 60 days without an update.
Physical and Medical Status: Warns after 60 days without an update.
Education Status: Warns after 60 days without an update.
Individualized Rationale: Warns after 60 days without an update.
Functional Impairment: Warns after 60 days without an update.
Background Information: Warns after 60 days without an update.

Recent-update warnings currently cover these plan areas:

Maladaptive plans: Current progress and current intensity should be updated within 60 days.
Replacement plans: Current progress should be updated within 60 days.
Caregiver training plans: Current progress should be updated within 60 days.
RBT training plans: Current progress should be updated within 60 days.
Teacher training plans: Current progress should be updated within 60 days.

4. UI Placement

Patients: Open the patient from the patient listing.
BIP View / Update: Use the BIP action for that patient.
Behavior Analysis Assessment (BIP): The checker appears in the editable BIP screen header, above the tabs.
Run BIP Checker: This button launches the review.
BIP Checker: %: After the review runs, this header indicator opens a popover with the result details.

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

Scenario A: Running the BIP Checker

Navigate to Patients and select the patient you want to review.
Click BIP View / Update to open the editable Behavior Analysis Assessment (BIP) screen.
Review or adjust Report Date and Months Range if needed.
Click Run BIP Checker.
Wait while the system processes the review. During this time, the button is disabled and the screen shows Checking....
When the check finishes, review the BIP Checker: % indicator and open it to see the results.

Scenario B: Reviewing the results

Open the checker result from the header indicator.
Review the Must Check column for items that need correction.
Review the Warnings column for items that may be outdated or need a closer look.
Use the labels and short descriptions in each row to identify what needs to be updated in the BIP.
Look at the overall percentage, progress bar, and item counts to understand the overall condition of the BIP.

Scenario C: Correcting the BIP and checking again

Update the needed sections directly in the editable BIP tabs.
Return to the top header area.
Click Run BIP Checker again.
Review the updated result, which replaces the previous one on screen.

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

Q: What happens if the user does not have permission to edit BIPs?
- A: The user does not see the checker. If they try to open the editable route, the app redirects them to the read-only BIP view instead.
Q: What happens if the BIP is incomplete?
- A: The checker still runs as long as a BIP already exists, and it lists missing or incomplete items under Must Check. If the BIP has not been created yet, the Run BIP Checker button stays disabled.
Q: What happens if a section is old but not necessarily wrong?
- A: The item appears under Warnings, which acts as a reminder to review the content without blocking work.
Q: What happens if analyst signatures are missing?
- A: The checker shows a warning in Warnings so the team can update the consent section.
Q: What happens if a rule does not apply to this BIP?
- A: That rule is counted internally as not applicable and affects the overall score, but it is not shown as a separate visible list in the interface.
Q: What happens if the checker fails unexpectedly?
- A: The loading state stops and the last result already visible on screen stays in place. The current frontend implementation does not show a dedicated toast, modal, or banner for this error.

Notes for stakeholders

The checker is presented in the interface as a review aid, not as a hard stop.
Results are grouped by severity into Must Check and Warnings.
The interface also shows Last Check: in the BIP header when a prior check exists.