System Requirements Document for Windy-Revenue

Introduction

The Windy-Revenue project aims to refactor into a multi-tenant SaaS platform focused on revenue recovery for Indian dental clinics. The platform will monitor and address revenue leakage by analyzing follow-ups, packages, and repeat visits, providing insights and actionable data to clinic managers.

System Overview

Product Interpretation and Delivery Boundary

• Domain Descriptor: Revenue Recovery

  • Source Evidence: The product aims to recover revenue through efficient management of clinic operations, specifically targeting Indian dental clinics.
  • Confidence: 0.9

• Product Scope: The system will focus on revenue recovery by analyzing follow-ups, packages, and repeat visits. It will provide insights to clinic managers to help them address these issues effectively.

• Excluded Assumptions: Generic clinic management features and patient record management are not included in this scope.

• Custom Pages:

  • Revenue Recovery Dashboard: Provides insights into revenue recovery and leakage trends.
  • Action Centre: Central hub for managing tasks related to revenue recovery.
  • Authentication: Provides a shared application access surface for persistent identity.

• Access: Application-owned identity is required for persistent identity and access to the system.

• Behavior Contracts:

  • Manage Revenue Recovery Tasks:
    • Actor: Clinic Manager
    • Trigger: Manual initiation or scheduled task
    • Inputs: Patient data, Appointment records, Treatment plans
    • Outcomes: Revenue recovery report, Task completion status
    • State Changes: Task records, Revenue recovery status
    • State Lifetime: Durable
    • Identity Continuity: Persistent
    • Audience Entry: Internal
    • Human Touchpoints: Action Centre, Dashboard
    • Failure Outcome: Task error notification
    • Access Owner: Application

Page Content and Component Coverage

Revenue Recovery Dashboard

• Information and Actions:

  • Display estimated opportunity and recovered revenue.
  • Show overdue follow-ups and outstanding balances.
  • Present recovery trends and actionable recommendations.

• Domain Entities:

  • Revenue leakage data
  • Follow-up records
  • Package details
  • Treatment plans

• Component Responsibilities:

  • Data visualization for revenue insights.
  • Interactive charts for follow-up and package analysis.
  • Notification system for analysis errors.

• States:

  • Loading state for data fetching.
  • Success state with actionable insights.
  • Error state with analysis error notifications.

Action Centre

• Information and Actions:

  • Manage tasks for calling, messaging, rescheduling, snoozing, and resolving.
  • Track task status and resolution history.

• Component Responsibilities:

  • Task management interface.
  • Integration with communication tools like WhatsApp.

• States:

  • Task initiation and completion states.
  • Error state for task management issues.

Authentication

• Information and Actions:

  • User sign-up and login.
  • Session management for persistent identity.

• Component Responsibilities:

  • Secure access control.
  • User session handling.

• States:

  • Login success and failure states.
  • Session timeout notifications.

Functional Requirements as Story Points

• As a Clinic Manager, I should be able to monitor revenue leakage in clinics by analyzing follow-ups, packages, and repeat visits to identify areas for improvement. explicit
• As a Clinic Manager, I should be able to sign up, log in, and maintain a session to access the clinic dashboard. required_inference
• As a Clinic Manager, I should be able to view a revenue leakage report generated from follow-up records, package details, and repeat visit data. basic_default
• As a Clinic Manager, I should receive notifications in case of analysis errors to take corrective actions. basic_default
• As a Clinic Manager, I should be able to manage tasks related to revenue recovery in the Action Centre. explicit
• As a Clinic Manager, I should be able to import data via CSV with preview, validation, and duplicate detection. explicit
• As a Clinic Manager, I should be able to define and manage transparent leakage rules for various scenarios. explicit
• As a Clinic Manager, I should be able to track treatment plans and package utilization. explicit
• As a Clinic Manager, I should be able to manage consent, opt-out options, and view audit logs. explicit
• As a Clinic Manager, I should be able to use seed data for dashboard functionality without integration. explicit

User Personas

• Clinic Manager: Responsible for overseeing clinic operations and addressing revenue leakage issues. This persona requires access to detailed insights and actionable data to make informed decisions.
• Staff Member: Assigned tasks related to revenue recovery and patient management.

Core User Flows

Clinic Manager Flow

1. Authentication: The Clinic Manager logs into the system using the authentication page.
2. Access Revenue Recovery Dashboard: Upon successful login, the Clinic Manager accesses the Revenue Recovery Dashboard.
3. Analyze Revenue Data: The Clinic Manager initiates or schedules an analysis of revenue data.
4. Review Insights: The Clinic Manager reviews the revenue leakage report and insights.
5. Take Action: Based on the insights, the Clinic Manager takes necessary actions to address revenue leakage.
6. Manage Tasks: The Clinic Manager uses the Action Centre to manage tasks related to revenue recovery.

Visuals Colors and Theme

[Default — not specified by user]

• Primary: #3498db (a calm blue representing trust and professionalism)
• Primary Light: #85c1e9 (a lighter tint for hover states)
• Secondary: #2ecc71 (a green for success and positive actions)
• Accent: #e74c3c (a red for alerts and notifications)
• Highlight: #f1c40f (a yellow for emphasis and active indicators)
• Background: #ecf0f1 (a light grey for page background)
• Surface: #ffffff (white for card/panel backgrounds)
• Text: #2c3e50 (dark grey for primary text)
• Text Muted: #95a5a6 (soft grey for secondary text)
• Border: #dcdcdc (subtle grey for borders)

Signature Design Concept

The Revenue Recovery Dashboard will feature a clean and professional layout with a focus on data visualization. The primary color palette will be used to highlight key insights and actionable items. Interactive charts and graphs will provide a clear view of revenue leakage areas, follow-up efficiency, and package utilization. The design will ensure that clinic managers can quickly interpret data and make informed decisions.

Interaction Model & Motion Direction

• Interaction Model: Animated
  • Moderate scroll-triggered reveals and hover transitions will be used to enhance the user experience on the Revenue Recovery Dashboard.
  • Interactive elements will have spring physics for a polished feel.

Non-Functional Requirements

• No additional non-functional requirements were inferred beyond the need for secure access control and persistent identity management.

Tech Stack

• Frontend: React for Web
• Backend: Python with FastAPI
• Database: MariaDB/PostgreSQL, using Alembic for migrations
• Local Orchestration: Docker and docker-compose

Assumptions and Constraints

• The system will not include generic clinic management features or patient record management.
• The focus will be on revenue recovery through follow-ups, packages, and repeat visits.

Glossary

• Revenue Leakage: Loss of potential revenue due to inefficiencies or missed opportunities in clinic operations.
• Follow-up Efficiency: The effectiveness of follow-up appointments in generating revenue.
• Package Utilization: The extent to which offered packages are used by patients.
• Clinic Manager: The individual responsible for managing clinic operations and addressing revenue issues.