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

Summary Widget

The Summary Widget displays intake sessions and completed summaries within your medical software. It can be mounted as a tab or panel in your patient dashboard, or as a daily intake overview for providers.

Mounting the widget

Mount the Summary Widget in your patient view and pass an intake session ID to open a specific summary.

const widget = squire.mountWidget('#intake-summary-container', 'intake-summary', { sessionId: 'intake_session_id', theme: { colorPrimary: '#337ab7', colorLightest: '#f8f9fa', borderRadius: '0.25rem', font: 'Roboto', }, });
<!-- Mount in a tab panel within your patient dashboard --> <div id="intake-summary-container"></div>

If you omit sessionId, the widget shows today’s intake sessions for the authenticated organization and lets the provider open one from the list.

Configuration Options

OptionTypeRequiredDescription
sessionIdstringNoThe intake session ID returned when creating a session. When omitted, the widget lists today’s intake sessions.
localestringNoWidget language. Supported values are en, nl, de, and fr.

Theming

Customize the widget’s appearance by passing a theme object:

PropertyTypeDefaultDescription
colorPrimarystring'#539DD6'Primary color for buttons and accents
colorLighteststring'#E1F1FD'Lightest color for backgrounds
borderRadiusstring'0.5rem'Border radius for UI elements
fontstring'system-ui, sans-serif'Font family (all Google Fonts  are supported)

Events

widget.on('loaded', () => { console.log('Intake summary widget loaded'); });
EventPayloadDescription
loadednullFired when the widget has initialized

Summary Content

The Summary Widget displays a structured overview of the patient’s intake responses, including:

  • Patient name, appointment time, email, and phone number when available
  • Intake config name and current status
  • A concise text summary
  • Structured summary entries
  • Conversation history between the patient and intake assistant
  • Intake timeline and completion state

Linking Intake with Consultation

Coming soon: the intake summary will be linkable with the Consultation widget to provide additional context during the consultation.

Last updated on