Skip to main content

Sessions

What it is

Create and manage client sessions and appointments

Who it's for

Workspace Owner Staff

Access & Scope

PropertyValue
Modulesessions
Personasworkspace-owner, staff
ScopeWorkspace-level
UI LocationDashboard > Sessions

| Status | active |

UI Location

Dashboard > Sessions

How it works

The Sessions feature provides comprehensive session and appointment management. Here's how it works:

  1. Session Creation: Create new sessions by providing:

    • Session name (required)
    • Client selection (required)
    • Date and start time (required)
    • Duration in minutes (required, minimum 1 minute)
    • Status: scheduled, in-progress, completed, or cancelled
    • Pre-session field values (custom fields for pre-session phase)
  2. Session Management:

    • View all sessions in calendar or list format
    • Edit session details (name, date, time, duration, status, client)
    • Delete sessions
    • Track session status through workflow stages
  3. Custom Fields System: Sessions support three phases of custom fields:

    • Pre-session fields: Completed before the session starts (e.g., intake forms, medical history)
    • During-session fields: Completed during the session (e.g., treatment notes, observations)
    • Post-session fields: Completed after the session (e.g., follow-up instructions, outcomes)
  4. Session Status Workflow:

    • Scheduled: Session is planned but not yet started
    • In-progress: Session is currently happening
    • Completed: Session has finished
    • Cancelled: Session was cancelled
  5. Working Hours Validation: The system checks if session times fall within workspace working hours and warns if outside normal business hours.

  6. Overlapping Sessions Detection: The system can detect and warn about overlapping sessions for the same client or staff member.

  7. Integration Features:

    • Link sessions to clients
    • Attach files and images to sessions
    • Add admin notes
    • Generate invoices from sessions
    • Link to client evaluations

Settings

The Sessions feature includes the following configurable settings:

  1. Session Field Management:

    • Create custom fields for each phase (pre, during, post)
    • Configure field types, labels, descriptions, and validation
    • Set field order within each phase
    • Mark fields as required or optional
    • Enable/disable field filtering in calendar view
    • Archive or restore fields
  2. Field Types: Same as client fields:

    • Text, textarea, number, boolean
    • Date, datetime
    • Select, multi-select
    • Image, file upload
    • Signature capture
    • Array and object (nested structures)
    • Team member selection
  3. Evaluation Field Management:

    • Separate field management for client evaluations
    • Evaluation fields are linked to sessions but managed independently
    • Support for the same field types as session fields
  4. Calendar Settings:

    • View modes: Day, Week, or Month
    • Time slot intervals (30-minute default)
    • Client filtering
    • Custom field filtering
    • Timezone handling (uses workspace timezone)
  5. Session Defaults:

    • Default duration (60 minutes)
    • Default status (scheduled)
    • Default time (09:00)

Permissions

Access to the Sessions feature is controlled by role-based permissions:

  • session.read: Required to view sessions in calendar or list view
  • session.create: Required to create new sessions
  • session.update: Required to edit existing sessions
  • session.delete: Required to delete sessions
  • session.fields.manage: Required to create, edit, archive, and reorder session field definitions
  • evaluation.fields.manage: Required to manage evaluation field definitions

Default Access:

  • Workspace Owner: Has all permissions by default
  • Staff: Permissions are granted based on their assigned roles. Staff without session.read permission will not be able to view sessions.

Note: Session field management and evaluation field management are separate permissions, allowing fine-grained control over who can modify form structures.

Use Cases

  1. Appointment Scheduling:

    • Schedule client appointments with specific dates and times
    • Set session duration based on service type
    • Track appointment status through the workflow
  2. Session Documentation:

    • Use pre-session fields to collect intake information
    • Use during-session fields to document treatment or service delivery
    • Use post-session fields to record outcomes and follow-up instructions
  3. Workflow Management:

    • Track sessions through their lifecycle (scheduled → in-progress → completed)
    • Cancel sessions when needed
    • View session history for clients
  4. Calendar Planning:

    • View all sessions in calendar format
    • Identify available time slots
    • Plan staff schedules
    • Avoid double-booking
  5. Client Progress Tracking:

    • Link multiple sessions to the same client
    • Track progress over time
    • Review session history
    • Generate progress reports
  6. Service Documentation:

    • Document services provided during sessions
    • Attach photos, files, or notes
    • Generate invoices from session data
    • Link to client evaluations

Notes / Limits

  1. Session Requirements:

    • Session name is required
    • Client must be selected (must exist in workspace)
    • Date and start time are required
    • Duration must be at least 1 minute
    • Date must be in valid ISO datetime format
  2. Working Hours:

    • Sessions can be created outside working hours, but a warning is displayed
    • Working hours are defined in workspace settings
    • Timezone is inherited from workspace settings
  3. Field Values:

    • Pre-session fields can be filled when creating a session
    • During and post-session fields are only available when editing existing sessions
    • Field values are saved per phase and can be updated independently
  4. Overlapping Sessions:

    • The system can detect overlapping sessions
    • Overlap detection considers session duration
    • Warnings are shown but don't prevent session creation
  5. Calendar Performance:

    • Calendar loads sessions for the visible date range
    • Large numbers of sessions may impact calendar rendering performance
    • Filtering by client or custom fields helps narrow results
  6. Session Deletion: Deleting a session is a permanent action. Related data (attachments, notes, invoices) may need to be handled separately.

  7. Status Transitions: While status can be changed manually, typical workflow is: scheduled → in-progress → completed. Cancelled sessions can be created at any time.

  8. Time Format: All times use 24-hour format (HH:mm). Timezone conversions are handled automatically based on workspace settings.

Changelog

Mon Jan 15 2024 02:00:00 GMT+0200 (Eastern European Standard Time)

  • Initial documentation