> ## Documentation Index
> Fetch the complete documentation index at: https://developer.suki.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Web SDK Types Reference

> Web SDK TypeScript type definitions, interfaces, and enums

In TypeScript, types and interfaces describe the shape of objects you pass into the SDK (for example initialization, mounting, and encounter data). They document which fields exist, which are required, and how values are typed so your editor can validate usage against this reference.

This page groups the Web SDK type topics below: core encounter and initialization types, UI and theme configuration, ambient session types, clinical data, and utility types. Each linked page includes an overview, a type snippet, and property details. Use the cards to jump to the full definition for the type you are implementing.

## Core types

Use these types for the following purposes:

* **Encounter**: Represents a clinical encounter that includes patient-related information.
* **Patient**: Contains patient demographics and identifying details.
* **InitOptions**: Defines configuration settings used to initialize the SDK.
* **PartnerDetails**: Includes partner authentication and provider information required during initialization, as described on the Partner details page.

> [!NOTE]
>
> * For ambient flows, **`patient.identifier`** is required. **`encounter.identifier`** is optional. Both must be strings of **at most 36 characters** (varchar(36) (VARCHAR is a variable-length SQL string type. varchar(36) caps these identifiers at 36 characters. See the Glossary.)). Longer values can fail during composition or ambient setup.
>
> * From Web SDK **v3.2.0**, if you set **`encounter.identifier`**, use a **UUID or non-UUID** value, at most **36 characters**. The SDK maps that value to **`emr_encounter_id`** for ambient interoperability and encounter note retrieval. See [Patient](https://developer.suki.ai/web-sdk/api-reference/types/patient.md), [Encounter](https://developer.suki.ai/web-sdk/api-reference/types/encounter.md) type definitions for more information.
>
> * From Web SDK **v3.3.0**, pass **`encounter.practitionerFhirId`** with **`encounter.identifier`** when you initialize and when you mount for Patient Summary on the headed patient profile. `setEncounter` loads another encounter's summary. It does not generate again. Initialize again to generate for a different practitioner. See [Patient Summary in Web SDK](https://developer.suki.ai/web-sdk/guides/patient-summary.md) for more information.

> [card] [Encounter](https://developer.suki.ai/web-sdk/api-reference/types/encounter.md)
>
> Clinical encounter.

> [card] [Patient](https://developer.suki.ai/web-sdk/api-reference/types/patient.md)
>
> Demographics; patient ID up to 36 characters.

> [card] [InitOptions](https://developer.suki.ai/web-sdk/api-reference/types/init-options.md)
>
> Configuration options for initializing the SDK.

> [card] [PartnerDetails](https://developer.suki.ai/web-sdk/api-reference/types/partner-details.md)
>
> Partner authentication and provider information.

## UI & theme configuration

Use these types for the following purposes:

* **ThemeOptions**: Customize the SDK's appearance.
* **MountOptions**: Mount the SDK to a DOM element and pass related options.
* **UIOptions**: Configure user interface behavior and settings.
* **SectionEditingOptions**: Configure section editing features within the SDK.

> [card] [ThemeOptions](https://developer.suki.ai/web-sdk/api-reference/types/theme-options.md)
>
> Configuration for customizing SDK appearance.

> [card] [MountOptions](https://developer.suki.ai/web-sdk/api-reference/types/mount-options.md)
>
> Configuration for mounting SDK to DOM element.

> [card] [UIOptions](https://developer.suki.ai/web-sdk/api-reference/types/ui-options.md)
>
> User interface configuration options.

> [card] [SectionEditingOptions](https://developer.suki.ai/web-sdk/api-reference/types/section-editing-options.md)
>
> Configuration for section editing features.

## Ambient session types

Use these types for the following purposes:

* **AmbientOptions**: Configure ambient session functionality.
* **Section**: Define a clinical note section using LOINC codes for ambient sessions.
* **EmitterEvents**: Handle events emitted by the Web SDK to monitor session state and process responses. See the Emitter events page for details on tracking authentication and ambient session lifecycle events.
* **NoteContent**: Define the structure of clinical note content, including optional diagnosis and LOINC code.

> [card] [AmbientOptions](https://developer.suki.ai/web-sdk/api-reference/types/ambient-options.md)
>
> Configuration for ambient session functionality.

> [card] [Section](https://developer.suki.ai/web-sdk/api-reference/types/section.md)
>
> Clinical note section using LOINC codes.

> [card] [EmitterEvents](https://developer.suki.ai/web-sdk/api-reference/types/emitter-events.md)
>
> Events emitted by the SDK for monitoring.

> [card] [NoteContent](https://developer.suki.ai/web-sdk/api-reference/types/note-content.md)
>
> Content structure for clinical notes.

## Clinical data types

Use these types for the following purposes:

* **Diagnosis**: Define the structure of clinical diagnosis information, including ICD codes.

> [card] [Diagnosis](https://developer.suki.ai/web-sdk/api-reference/types/diagnosis.md)
>
> Clinical diagnosis information with ICD codes.

## Utility types

Use these types for the following purposes:

* **LogLevel**: Control debug output verbosity.
* **SukiError**: Define the structure of SDK errors, including `code` and `details`. See the Suki error page for details.

> [card] [LogLevel](https://developer.suki.ai/web-sdk/api-reference/types/log-level.md)
>
> Log levels for controlling debug output.

> [card] [SukiError](https://developer.suki.ai/web-sdk/api-reference/types/suki-error.md)
>
> Error structure with codes and details.

## Next steps

&#x20;**[Classes](https://developer.suki.ai/web-sdk/api-reference/classes.md)** - Section for information on available SDK classes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.