SessionContext Types - Suki

SessionContext type

Below is the type definition for the SessionContext type. You provide this context using the setSessionContext method to help Suki’s AI generate more accurate and meaningful clinical notes.

type SessionContext = {
  patient?: {
    dob: string;
    sex: string;
    patient_id?: string;
    name?: {
      family?: string;
      given?: string[];
      suffix?: string[];
      use?: string;
    };
  };
  provider?: {
    specialty: string; // Enum token, for example FAMILY_MEDICINE
    role?: string;
  };
  visit?: {
    visit_type?: string;
    encounter_type?: string;
    reason_for_visit?: string;
    chief_complaint?: string;
  };
  sections?: Array<{ loinc: string }>;
  diagnoses?: {
    values: Array<{
      codes: Array<{
        code: string;
        description: string;
        type: string;
      }>;
      diagnosisNote: string;
    }>;
  };
};

Patient identity and name

Field	Type	Description
`patient.patient_id`	`string` (optional)	Patient identifier in your EMR or application.
`patient.name.family`	`string` (optional)	Family name.
`patient.name.given`	`string[]` (optional)	Given names.
`patient.name.suffix`	`string[]` (optional)	Name suffixes.
`patient.name.use`	`string` (optional)	Name use, for example `official`.

An empty name object is dropped and is not sent.
Name values are passed through as provided. The SDK does not force normalization.
Web SDK handoff: If you capture audio in Headless but the clinician reviews the note in the Web SDK, send patient_id and structured name with setSessionContext. Suki uses those fields to fill in the patient header in the Web SDK. Refer to Seed patient context for Web SDK handoff.

setSessionContext return type

setSessionContext returns Promise<void>. On success the promise resolves with no value. On failure it throws a ContextUpdateFailed error. Refer to Error handling.

Last modified on September 2, 2026