Types Reference

type Encounter = {
  identifier?: string;
  patient: Patient;
};

type Patient = {
  identifier: string;
  kind?: string;
  name: {
    use: string;
    family: string;
    given: string[];
    suffix: string[];
  };
  birthDate: string;
  gender: "MALE" | "FEMALE" | "UNKNOWN";
};

type InitOptions = PartnerDetails & {
  enableDebug?: boolean;
  logLevel?: LogLevel;
  isTestMode?: boolean;
  theme?: ThemeOptions;
};

type PartnerDetails = {
  partnerId: string;
  partnerToken: string;
  providerName: string;
  providerOrgId: string;
  providerSpecialty?: string;
  providerId?: string;
};

type ThemeOptions = {
  primary?: string;
  background?: string;
  secondaryBackground?: string;
  foreground?: string;
  warning?: string;
};

type MountOptions = {
  rootElement: HTMLElement;
  encounter: Encounter;
  uiOptions?: UIOptions;
  ambientOptions?: AmbientOptions;
};

type UIOptions = {
  showCloseButton?: boolean;
  showCreateEmptyNoteButton?: boolean;
  sectionEditing?: SectionEditingOptions;
  showStartAmbientButton?: boolean;
};

type SectionEditingOptions = {
  enableDictation?: boolean;
  enableCopy?: boolean;
};

type AmbientOptions = {
  prefill?: {
    noteTypeIds?: string[];
  };
  sections?: Section[];
};

type Section = {
  loinc: string;
  isPBNSection?: boolean;
};

type LogLevel = "debug" | "info" | "warn" | "error" | "log";

type EmitterEvents = {
  ready: never;
  "init:change": boolean;
  close: never;
  "ambient:update": {
    ambientId: string;
    isAmbientInProgress: boolean;
    isAmbientPaused: boolean;
  };
  "note-submission:success": {
    noteId: string;
    contents: Array<{ title: string; content: NoteContent }>;
  };
  error: SukiError;
};

type NoteContent = {
  title: string;
  content: string;
  diagnosis?: Diagnosis;
  loinc_code?: string;
};

type Diagnosis = {
  icdCode: string;
  icdDescription: string;
  snomedCode: string;
  snomedDescription: string;
  hccCode: string;
  panelRanking: number;
  billable: boolean;
  problemLabel: string;
  suggestionType: "DEFAULT" | "ED" | "PL";
};

type SukiError = {
  code: ErrorCode;
  details: ErrorDetail;
};

type ErrorDetail = {
  name: `init:sdk-init-failed` | `init:auth-failed` ...;
  message: string;
  reason?: ErrorReasons;
}

type ErrorReasons =
  | "lib-error"
  | "no-init"
  | "no-partner-token"
  | "missing-partner-details"
  | "no-init-or-auth"
  | "service-error"
  | "already-started"
  | "no-ambient"
  | "ambient-in-progress"
  | "invalid-encounter"
  | "unsupported-loinc-codes"
  | "no-supported-loinc-codes"
  | "multiple-pbn-sections";