MountOptions Type

MountOptions type represents the configuration options for mounting the SDK to a DOM element. The code snippet below shows how to use the MountOptions type to create a mount options object.

JavaScript

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

Properties

Hide properties

HTMLElement

required

The DOM element to mount the SDK into. Should be an empty container element

Encounter

required

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

UIOptions

UI configuration options

AmbientOptions

Ambient session configuration options

Last modified on May 22, 2026

ThemeOptions Type

UIOptions Type

⌘I

Get Started

Concepts & Feature Guides

API Reference

Resources

MountOptions Type

Properties

​Properties

Properties