Skip to main content

​
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;
  };
  provider?: {
    specialty: string;
    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;
    }>;
  };
};

​
SessionContextResponse Type

Below is the type definition for the SessionContextResponse type. This is the return type for the setSessionContext method. It returns an empty object {} when successful. If there’s an error, the method throws a ContextUpdateFailed error. 
type SessionContextResponse = Record<string, never>;

​
Related Content

setSessionContext method

Sends additional metadata to the Suki backend server to help generate more accurate notes.

Session Context guide

Learn how to use session context to improve note generation quality.

Context Update Errors

Error codes for context update failures.