[draft] healthcare agent example

[tinalenguyen]

Summary by CodeRabbit

• New Features
  • Added a healthcare agent example with voice-based interaction capabilities
  • Supports insurance information collection from patients
  • Enables appointment scheduling with doctor selection and confirmation
  • Includes patient information gathering workflow (name, date of birth, email, insurance)

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

A new healthcare agent workflow module is introduced featuring data structures for insurance and appointment results, task implementations for collecting insurance and scheduling appointments, and a core HealthcareAgent with information gathering, appointment scheduling, and server integration capabilities.

Changes

Cohort / File(s)	Summary
Data Structures examples/healthcare/healthcare_agent.py	Introduces GetInsuranceResult with insurance field and ScheduleAppointmentResult with doctor_name, appointment_time, and visit_reason fields
Task Implementations examples/healthcare/healthcare_agent.py	Implements GetInsuranceTask with insurance collection via record_health_insurance tool; implements ScheduleAppointmentTask with doctor confirmation, visit reason validation, and appointment scheduling with error handling for required fields
Agent and Server Setup examples/healthcare/healthcare_agent.py	Adds HealthcareAgent class with information gathering factory, appointment scheduling, and records update methods; creates AgentServer instance and RTC-wrapped entrypoint for real-time session management with STT/LLM/TTS/VAD backends

Sequence Diagram

sequenceDiagram
    participant Client as RTCClient
    participant Agent as HealthcareAgent
    participant InfoTG as TaskGroup<br/>(Information)
    participant GetInsTask as GetInsuranceTask
    participant SchAppTask as ScheduleAppointmentTask
    
    Client->>Agent: Start Session
    Agent->>Agent: on_enter() - gather reason for call
    Client->>Agent: schedule_appointment()
    Agent->>InfoTG: build information TaskGroup
    InfoTG->>GetInsTask: collect insurance info
    GetInsTask->>Client: prompt for insurance
    Client->>GetInsTask: record_health_insurance()
    GetInsTask->>InfoTG: complete with GetInsuranceResult
    InfoTG->>SchAppTask: begin appointment scheduling
    SchAppTask->>Client: confirm doctor selection
    Client->>SchAppTask: confirm_doctor_selection()
    SchAppTask->>Client: confirm visit reason
    Client->>SchAppTask: confirm_visit_reason()
    SchAppTask->>Client: schedule appointment
    Client->>SchAppTask: schedule_appointment(time)
    SchAppTask->>SchAppTask: validate required fields
    SchAppTask->>InfoTG: complete with ScheduleAppointmentResult
    InfoTG->>Agent: information gathering complete
    Agent->>Client: return completion message

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A hopping healthcare workflow hops into place,
Insurance and doctors in time-saving grace,
Task by task we gather the care,
Scheduling appointments with rabbit-like flair! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 28.57% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: introducing a new healthcare agent example module with multiple task implementations and data structures.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 5

🤖 Fix all issues with AI agents

In `@examples/healthcare/healthcare_agent.py`:
- Around line 145-146: The variable results assigned from awaiting task_group is
unused and triggers ruff F841; either remove the binding or use the
value—replace "results = await task_group" with just "await task_group" to avoid
the unused variable, or if you intend to persist task outputs, iterate the
returned results and load them into the DB (e.g., process/insert each item) so
the results from task_group are consumed; apply the same change for the other
occurrence where results is assigned.
- Around line 72-76: The tool handler stubs never store the user's choices, so
implement the handlers (e.g., the `@function_tool` methods
confirm_doctor_selection and the corresponding confirm_visit_reason handler) to
set the agent's state fields _selected_doctor and _visit_reason respectively
from their arguments, persist any needed normalized values, and return a short
confirmation string; update any downstream call in on_enter or schedule flow to
read these fields so scheduling can proceed.
- Around line 78-88: schedule_appointment currently passes the appointment_time
string into ScheduleAppointmentResult which expects a datetime; parse and
validate the incoming appointment_time string into a datetime before calling
self.complete. In schedule_appointment, use a safe parser (e.g.,
datetime.fromisoformat or a robust parser) to convert appointment_time to a
datetime, catch parsing exceptions and call self.session.generate_reply with a
clear error message if parsing fails, and only construct
ScheduleAppointmentResult with the parsed datetime
(doctor_name=self._selected_doctor, appointment_time=<parsed_datetime>,
visit_reason=self._visit_reason) when validation succeeds.
- Around line 96-101: The instructions string in HealthcareAgent tells the model
to call EndCallTool but EndCallTool is not imported or registered; either remove
the "call EndCallTool" phrase from the instructions or register the tool by
importing EndCallTool and passing it in the Agent's tools parameter (uncomment
and wire the existing tools=[EndCallTool(...)] line), ensuring the tools list
includes the EndCallTool instance and any required end_instructions so the model
can actually invoke it; update HealthcareAgent.__init__ accordingly and keep the
"schedule_appointment" instruction if that tool is handled separately.
- Around line 69-70: Replace the Python 3.10-only union annotations with
typing.Optional for compatibility: import Optional from typing at the top of the
module, and change the attributes self._selected_doctor: str | None and
self._visit_reason: str | None to use Optional[str] (i.e.,
self._selected_doctor: Optional[str] and self._visit_reason: Optional[str]);
ensure the import is added only if not already present.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7fe642d and e1f6935.

📒 Files selected for processing (1)

• examples/healthcare/healthcare_agent.py

🧰 Additional context used

📓 Path-based instructions (1)

**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

**/*.py: Format code with ruff
Run ruff linter and auto-fix issues
Run mypy type checker in strict mode
Maintain line length of 100 characters maximum
Ensure Python 3.9+ compatibility
Use Google-style docstrings

Files:

• examples/healthcare/healthcare_agent.py

🧠 Learnings (1)

📓 Common learnings

Learnt from: CR
Repo: livekit/agents PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-16T07:44:49.987Z
Learning: Follow the guidelines and standards defined in AGENTS.md

🧬 Code graph analysis (1)

examples/healthcare/healthcare_agent.py (3)

livekit-agents/livekit/agents/voice/agent.py (4)

• Agent (34-642)
• AgentTask (648-813)
• instructions (99-104)
• complete (687-706)

livekit-agents/livekit/agents/beta/workflows/email_address.py (1)

• GetEmailTask (27-130)

livekit-agents/livekit/agents/beta/workflows/task_group.py (1)

• TaskGroup (39-155)

🪛 GitHub Check: ruff

examples/healthcare/healthcare_agent.py

[failure] 159-159: Ruff (F841)
examples/healthcare/healthcare_agent.py:159:9: F841 Local variable results is assigned to but never used

---

[failure] 145-145: Ruff (F841)
examples/healthcare/healthcare_agent.py:145:9: F841 Local variable results is assigned to but never used

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: type-check (3.13)
• GitHub Check: type-check (3.9)
• GitHub Check: livekit-plugins-cartesia
• GitHub Check: livekit-plugins-deepgram
• GitHub Check: unit-tests

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}