Classes Reference

Web SDK class definitions, constructors, and methods reference

This section provides a detailed reference for all classes available in the Suki Web SDK.

SDKClient instance

The SDKClientInstance is the primary interface for interacting with the Suki Web SDK, providing comprehensive methods for managing encounters, ambient sessions, and event subscriptions.

The code snippet below shows how to use the SDKClientInstance class to interact with the Suki Web SDK.

JavaScript

interface SDKClientInstance {
  activeAmbientId: string | null;
  attemptLogin(): Promise<true | void>;
  setPartnerToken(partnerToken: string): void;
  cancelAmbient(): void;
  cleanup(): void;
  destroy(): void;
  mount(options: MountOptions): Promise<void>;
  on<T extends keyof EmitterEvents>(
    type: T,
    handler: (data: EmitterEvents[T]) => void | Promise<void>,
  ): () => void;
  pauseAmbient(): void;
  resumeAmbient(): void;
  setAmbientOptions(options: AmbientOptions): void;
  setEncounter(encounter: Encounter): Promise<void>;
  startAmbient(): void;
  submitAmbient(): void;
}

Properties

activeAmbientId · string | null

The ID of the currently active ambient session, or null if no session is active.

Available methods

Hide available methods

attemptLogin · Promise<true | void>

Re-authenticates the user with the SDK. This method does not take any parameters.

cancelAmbient · void

Cancels the current ambient session. This method does not take any parameters.

cleanup · void

Cleans up the SDK and removes all event listeners. This method does not take any parameters.

destroy · void

Destroys the SDK instance and stops the token refresh mechanism. This method does not take any parameters. For more information, see the Token refresh guide.

mount · Promise<void>

Mounts the SDK to a specified DOM element with the provided configuration options.

Hide parameters

options · MountOptions · required

The configuration options for mounting the SDK.

on · () => void

Subscribes to SDK events. This method returns an unsubscribe function.

Hide parameters

type · T · required

The type of event to subscribe to (e.g., 'ready', 'ambient:update').

handler · (data: EmitterEvents[T]) => void | Promise<void> · required

The callback function to be executed when the event is emitted.

pauseAmbient · void

Pauses the current ambient session. This method does not take any parameters.

resumeAmbient · void

Resumes a paused ambient session. This method does not take any parameters.

setAmbientOptions · void

Updates the ambient session configuration dynamically.

Hide parameters

options · AmbientOptions · required

The new ambient session configuration options.

setEncounter · Promise<void>

Sets the encounter context for the next ambient session. Call this before you start ambient, or after the current ambient session ends. If an ambient session is in progress, the call fails with SUKI0014 (ambient-in-progress).

Hide parameters

encounter · Encounter · required

Full Encounter payload. patient.identifier is required. encounter.identifier is optional. Each value must be at most 36 characters (varchar(36)) when present.

• From Web SDK v3.2.0, if you set encounter.identifier, use a UUID. The Web SDK maps that value to emr_encounter_id for ambient interoperability and encounter note retrieval. Non-UUID values can break past-note loading even when ambient session start, pause, and submit still work. Refer to Encounter type definition for more information.
• From Web SDK v3.3.0, Patient Summary uses encounter.identifier and encounter.practitionerFhirId on the headed patient profile. Pass practitionerFhirId when you initialize and when you mount. setEncounter can switch the encounter so the profile can load that summary. It does not generate again. Initialize again to generate for a different practitioner. Refer to Patient Summary in Web SDK for more information.

setPartnerToken · void

Updates the partnerToken for authentication after a token refresh.

Hide parameters

partnerToken · string · required

The new partnerToken string.

startAmbient · void

Starts a new ambient session. This method does not take any parameters.

submitAmbient · void

Submits the current ambient session for processing. This method does not take any parameters.

Next steps

Refer to the Functions to learn more about the available functions in the Suki Web SDK.