Clinic Console

Your provider home: new leads, active cases, rating and open pipeline at a glance.

<!-- GENERATED FILE. Do not edit by hand. Source: components/help/content/. Run npm run gen:docs. -->

Purpose & Business Context

The Clinic Console is the provider's home base, the mirror image of the patient's Journey dashboard. A cross-border partner clinic needs to know, the moment it signs in, how many new patients are waiting on a reply, which cases are in flight, how its reputation is trending, and how much revenue is in the pipeline. This screen collapses all of that into four clickable tiles and two snapshot panels.

Commercially it is the response-time surface of the console. In medical tourism, the clinic that quotes fastest usually wins the case, so the dashboard leads with New inquiries and a Needs attention list to pull staff straight to unanswered, revenue-bearing work.

Screen Overview

A scrollable dashboard for Apollo Hospitals, Chennai. At the top sit four KPI stat tiles (New inquiries, Active cases, Clinic rating, Open pipeline). Below them a two-up row pairs the Needs attention inbox preview with a Pipeline snapshot grouped by case stage. A final Manage your clinic card holds quick-link buttons to the profile, pricing, reviews and team screens.

Every tile and pipeline row is a shortcut: clicking deep-links to the screen that owns that data, so the dashboard doubles as the console's primary navigation hub.

Controls & Components

• Stat tiles (x4): New inquiries (routes to Inquiries), Active cases (routes to Cases), Clinic rating with stars (routes to Reviews), Open pipeline value (routes to Cases). Each is a clickable Card.
• Needs attention card: a preview list of every inquiry whose status is New or Quoted, each row showing the patient, procedure, date, a status Badge and a Respond button that opens Inquiries.
• Pipeline snapshot card: the six case stages (Inquiry, Quoted, Treatment planned, In treatment, Recovery, Closed) each with a live count; clicking any row opens Cases.
• Manage your clinic card: quick-link buttons, Edit public profile, Update pricing, Reply to reviews and Manage team.

Field Definitions

• New inquiries: The count of inbox items with status New, awaiting a first response. Sourced from the clinic inquiries list.
• Active cases: Open cases, meaning every case whose stage is not Closed. These are patients the clinic is actively treating.
• Clinic rating: The blended verified-review score for the clinic (4.8 for Apollo), with the total verified count beneath it.
• Open pipeline: The summed case value (USD) of all open cases, an at-a-glance revenue-in-flight figure.
• Needs attention: The subset of inquiries with status New or Quoted, the items most likely to need a reply or a nudge.
• Pipeline stage count: How many cases sit in each of the six stages; a dot turns teal when a stage has at least one case.

User Actions & Workflows

1. Scan the four KPI tiles to read the state of the clinic in one glance.
2. Click New inquiries (or a Respond button in Needs attention) to jump to the inbox and quote a lead.
3. Click Active cases or Open pipeline to open the cases board.
4. Click Clinic rating to review and reply to verified feedback.
5. Use the Manage your clinic buttons to edit the profile, update pricing, reply to reviews or manage the team.

Navigation & Relationships

Reached from: the sidebar Dashboard item (the default landing after a clinic signs in), the brand mark, and the post-login redirect. The route /clinic is matched exactly, not by prefix.

Leads to: Inquiries (/clinic/inquiries), Cases (/clinic/cases), Reviews (/clinic/reviews), Profile (/clinic/profile), Pricing (/clinic/pricing) and Team (/clinic/team) via the tiles, the Needs attention rows and the Manage buttons.

Mirrors: the patient Journey dashboard's stat-tile pattern, but with provider-side metrics. Counts here move whenever an inquiry status or case stage changes on those owning screens.

Business Rules & Constraints

• Clinic-only screen; gated by RequireAuth with role "clinic".
• All tiles are read-only summaries; the underlying values can only be changed on their owning screens.
• Active cases and Open pipeline both exclude Closed cases by definition.
• Needs attention is limited to New and Quoted inquiries; Accepted and Declined items drop off the list.
• When the inbox is clear, Needs attention shows a 'You're all caught up.' empty state instead of rows.

Data Dependencies

Reads myClinic() (the logged-in clinic's marketplace record, resolved from clinicAccount.clinicId), plus clinicInquiries and clinicCases from lib/data. KPI values and the pipeline counts are derived from those arrays at render time.

• myClinic(): name, rating and verified-review count for the rating tile
• clinicInquiries: drives New inquiries and the Needs attention list
• clinicCases: drives Active cases, Open pipeline value and the stage snapshot

Error Handling & Edge Cases

• Unauthenticated or non-clinic access is redirected by RequireAuth before the dashboard renders.
• Empty inbox: Needs attention renders the caught-up message rather than a blank panel.
• A stage with zero cases still appears in the snapshot, but with a muted dot and a gray count.
• Mobile: the sidebar collapses behind the menu button and the four tiles reflow to a single column.

User Roles & Permissions

• Clinic admin: Full view of every tile and panel, and can follow any link to act on inquiries, cases, pricing, reviews and team.
• Clinic staff: Same dashboard view and navigation. Day-to-day staff use it as a worklist; account-level changes (payouts, team membership) are an admin responsibility on the owning screens.
• Patient / other roles: No access; the /clinic/* tree is gated to the clinic role. The demo signs in as a single clinic account (Ravi Kumar, Apollo).

Related Features & Functionalities

The Inquiries inbox, the Cases board, the Reviews screen and the Profile, Pricing and Team editors all hang off this hub. The topbar notifications bell echoes the same events (new inquiry, escrow released, new review) that move the tiles, and the context Help panel and walkthrough are reachable from the topbar Help button.

Flow & Screenshots

flowchart LR
  SignIn[Clinic sign in] --> D[Clinic Console]
  D -->|New inquiries / Respond| Inq[Inquiries]
  D -->|Active cases / Open pipeline| Cases[Cases]
  D -->|Clinic rating| Rev[Reviews]
  D -->|Manage: profile| Prof[Profile]
  D -->|Manage: pricing| Price[Pricing]
  D -->|Manage: team| Team[Team]

Guided Walkthrough Steps

The in-app walkthrough for this screen has 7 steps (auto-advances every 5 seconds; Prev / Pause / Next; click outside to exit):

1. Your console home ([data-tour="nav.dashboard"])

This is your provider home base. The left sidebar moves you between the parts of the console; Dashboard is selected now.

1. Your clinic at a glance ([data-tour="dashboard.stats"])

Four live metrics: new inquiries, active cases, your verified rating and open pipeline value. Each tile is a shortcut, click one to jump to that screen.

1. Needs attention ([data-tour="dashboard.attention"])

Every inquiry still New or Quoted, surfaced so you can reply fast. The Respond button opens the inbox for that lead.

1. Pipeline snapshot ([data-tour="dashboard.pipeline"])

Your cases grouped by stage, from Inquiry to Closed. Click any row to open the cases board filtered to your work.

1. Manage your clinic ([data-tour="dashboard.manage"])

Quick links to edit your public profile, update pricing, reply to reviews and manage your team.

1. Stay in the loop ([data-tour="topbar.notifications"])

The bell collects clinic events, new inquiries, escrow releases and fresh reviews, so nothing slips by.

1. Help is always here ([data-tour="topbar.help"])

Open Help on any console screen for documentation, and press Play to replay a walkthrough like this one.