Skip to Content
SDK 1.14 is out with per-user product usage and typed API errors. Read the changelog →
IntakeOverview

Intake

Intake lets healthcare providers digitize patient intake workflows. By integrating Intake into your medical or calendar software, patients can complete intake questionnaires before their appointment, and providers can view structured summaries directly within their existing system.

How it works

The Intake integration consists of three main components:

  1. Scheduling API: create intake sessions via the SDK, linked to your calendar system. Patient data and a unique patient ID are passed along so results can be queried later.
  2. Protocol widget: an embeddable widget that lets providers create, configure, activate, and deactivate intake configs.
  3. Summary widget: an embeddable widget that displays intake sessions and completed summaries within your application.

Integration approach

ComponentIntegration methodPurpose
SchedulingSDK / APICreate and schedule intake sessions from your calendar
Protocol widgetWidgetCreate and configure intake configs
Summary widgetWidgetView intake sessions and completed summaries in your application
Email & DNSPortal configurationConfigure custom email sender and hostname

The scheduling component is intentionally API-based (not a widget) to allow seamless integration with any calendar system without replacing your existing scheduling workflow.

Prerequisites

Last updated on