Scheduling

Intake sessions are created via the SDK’s API rather than through a widget. This allows you to keep your existing calendar and booking flow while connecting it to Squire Intake behind the scenes.

Scheduling is API-based so you can integrate it directly into your existing calendar system without replacing your booking UI.

Flow

List available intake configs

Before creating a session, retrieve the available intake configs. Each one represents a specific intake questionnaire.


const configs = await squire.intake.getIntakeConfigs();

The function returns a list of intake configs, each with the following properties:

Property	Type	Description
`id`	string	Unique identifier of the intake config
`name`	string	Human-readable name of the intake config

Create an intake session

Create a new intake session by calling createSession with the patient data, selected intake config, and appointment details.


const session = await squire.intake.createSession({
  intakeConfigId: 'intake_config_id',
  appointmentDt: '2025-06-15T10:00:00Z',
  firstName: 'John',
  lastName: 'Doe',
  email: 'john.doe@example.com',
  phoneNumber: '+32412345678',
  healthcareProviderId: 'your_ehr_user_id',
});

Session Parameters

Parameter	Type	Required	Description
`intakeConfigId`	string	Yes	The ID of the intake config to use (from `getIntakeConfigs()`)
`appointmentDt`	string \| Date	Yes	Scheduled date and time of the appointment (ISO 8601 or `Date` object)
`firstName`	string	No	Patient’s first name
`lastName`	string	No	Patient’s last name
`email`	string	No	Patient’s email address (used for sending the intake invitation)
`phoneNumber`	string	No	Patient’s phone number
`healthcareProviderId`	string	No	The healthcare provider’s user identifier from your system

Session Response

The createSession call returns an IntakeSession object:

Property	Type	Description
`id`	string	Unique session identifier
`intakeUrl`	string	URL sent to the patient to complete the intake

What Happens Next

After a session is created:

The patient receives an email invitation with a link to complete the intake questionnaire.
The patient fills in the questionnaire at their own pace before the appointment.
Once completed, the intake summary becomes available and can be viewed via the Summary Widget.