Fertiligent API Documentation

website·Indexed 31 days ago

https://docs.fertiligent.ai

API reference for Fertiligent, featuring endpoints for patient portal management, care referrals, episode outcomes, document management, and voice support messaging.

Tokens
46.6K
Snippets
187
Records
468
Agent score
52%

What's inside Fertiligent

  1. Overview of Patient Portal visibility and features

    The patient portal provides a secure, patient-facing view of a person's care. Patients can only see their own information and only the data the clinic has explicitly made patient-visible. Key visible components include:

    • Profile: Demographics and contact details (editable by the patient).
    • Cases and Episodes: Treatment arrangements and care episodes.
    • Care Timeline: Verified monitoring entries (e.g., bloodwork, ultrasound) and approved Day-5 embryology updates.
    • Outcomes: Clinical outcomes for episodes.
    • Alerts: Items requiring patient attention.
    • Documents: Files shared by the clinic.
    • Messages: Direct communication with the care team.
  2. Overview of Fertiligent AI platform

    Fertiligent is an AI platform designed for fertility clinics. It manages referral intake, patient outreach and booking, voice and messaging assistants, scheduling, and clinical records.
  3. Overview of Fertiligent AI Operating System capabilities

    Fertiligent is an AI operating system for fertility clinics that provides a clinic-governed agent across all patient channels. The platform is organized into four primary work tracks:

    1. Intake & Referrals: Managing inbound leads and referral documents.
    2. Patient Communication: Handling multi-channel interactions (Voice, SMS, Email, Portal).
    3. Clinical Copilot & EMR: Assisting with clinical documentation and EMR data flow.
    4. Trust & Compliance: Ensuring data ownership, HIPAA alignment, and security.
  4. Overview of Fertiligent assistant capabilities

    The Fertiligent assistant is a bounded AI designed to handle routine intake and answer approved questions across multiple channels. It is strictly prohibited from acting as a clinician, improvising answers, or providing medical advice. Key capabilities include:

    • Knowledge Base Retrieval: Answers questions using only the clinic's curated knowledge base (e.g., hours, funding).
    • Intake Capture: Collects inquiry details and creates prospect records with full history.
    • Identity Verification: Confirms patient identity (typically via date of birth) before sharing personal information.
    • Appointment Booking: Allows patients to book nurse intake calls via website chat (Eva) or text.
    • Result Relaying: Delivers clinician-approved explanations of results (e.g., Day-5 embryology updates) exactly as written.
    • Multilingual Support: Responds in the patient's language, including European Portuguese for phone and portal.
    • Staff Assistance: Drafts suggested replies for staff review in patient messaging.
    • Patient Care Support: Helps verified patients look up/confirm appointments, request cancellations/reschedules, or update contact details.
    • Outreach Management: Records patient communication preferences as part of outreach sequences.
    • Human Handoff: Escalates any query outside its defined scope to the clinic team.
  5. Overview of Eva AI patient companion capabilities

    Eva is a patient-facing AI companion that can be embedded on clinic websites or patient portals. Her primary functions include:

    • Knowledge Base Q&A: Answers questions using only clinic-curated materials (services, pricing, FAQs, policies). If no confident answer is found, she refers the user to the clinic team.
    • Appointment Booking: Books the first visit by offering open nurse-intake slots.
    • Lead Capture: Converts anonymous chats into 'prospects' once the visitor shares their details.
    • Intake Assistance: Collects structured intake information from prospective patients.
    • Staff Handoff: Initiates conversations that land in the clinic's messaging inbox when a human is needed.
    • Document Sharing: Surfaces available patient documents.
  6. Overview of Fertiligent AI Operating System

    Fertiligent is an AI-native operating system designed for fertility clinics. It integrates three primary components: a patient-facing voice and messaging agent, a referral-intake pipeline, and a scheduling and care-coordination portal. Key capabilities include:

    • Unified Prospect Management: Consolidates referrals, calls, web chats, and texts into a single prospect record with full history.
    • Automated Referral Processing: Automatically reads and structures referral letters and allows patients to self-book intake calls.
    • 24/7 Coverage: Provides automated responses and intake handling via phone, website, and text outside of business hours.
    • Controlled AI Responses: The assistant only uses approved materials, requires verification/consent before sharing health information, and escalates sensitive issues to clinic staff.
  7. Manage clinic information using the Knowledge Base

    The knowledge base is a curated set of clinic information used by the AI assistant (via phone, Eva patient companion, and messaging) to provide grounded answers. The assistant only answers based on approved materials; if a confident answer cannot be found in the knowledge base, the assistant performs a hand-off to a human staff member rather than guessing or inventing information.
  8. Retrieve embryo storage details by ID

    Use the GET /api/care/embryo-storage/{id} endpoint to retrieve detailed information about a specific embryo storage record using its unique identifier. The API supports standard HTTP response codes including 200 (OK), 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 500 (Internal Server Error), and 501 (Not Implemented).
    curl -X GET "https://<your-domain>/api/care/embryo-storage/{id}"
  9. Understand the Fertiligent prospect pipeline

    A prospect is a potential patient moving through the outreach and intake funnel before becoming an active patient. Fertiligent automatically captures prospects from the following intake channels into a single pipeline:

    • Conversations with Eva (website companion)
    • Follow-ups from phone calls
    • Confirmed referrals
    • Imports from other systems (e.g., CRM)
  10. Configure the AI Assistant (Eva) and Knowledge Base

    The patient-facing assistant, Eva, operates based on a Knowledge base, which consists of approved materials. Eva will not provide answers outside the scope of the knowledge base. If a conversation becomes sensitive, uncertain, or clinical, the assistant performs an Escalation, handing the conversation over to a human staff member.
  11. Generate patient documents from a session

    Users can generate various documents from a visit using the 'Ask about this session' line at the foot of the page.

    Available document types include:

    • Letters to patients, family physicians, or referral letters.
    • Work-up letters, consent discussions, and summaries.

    Quick asks are available for common documents (patient copy, referral, family physician letter, chart summary) to pre-fill the request. Documents support paragraphs, lists, and headings. They can be rewritten in different languages from their own tab and must be reviewed against the transcript before being sent. Closing a document removes it from the active list but preserves it for audit purposes.

  12. Understand Tenant and Conversation management

    A Tenant is a clinic's private, isolated instance of the platform, containing its own data, branding, and portal. All interactions handled by the assistant across phone, text, portal, and email are aggregated in the Conversations shared worklist.