MountOptions Type

MountOptions type represents the configuration options for mounting the SDK to a DOM element

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

rootElement · HTMLElement · required

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

encounter · Encounter · required

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

• From Web SDK v3.2.0, if you set encounter.identifier, use a UUID. The Web SDK maps that value to emr_encounter_id for ambient interoperability and encounter note retrieval. Non-UUID values can break past-note loading even when ambient session start, pause, and submit still work. Refer to Encounter type definition for more information.

• From Web SDK v3.3.0, set encounter.practitionerFhirId (FHIR practitioner id) together with encounter.identifier (FHIR encounter id) when you initialize and when you mount if you want Patient Summary on the headed patient profile. Generation runs at login from the initialize options. setEncounter loads another encounter’s summary. Initialize again to generate for a different practitioner. Refer to Patient Summary in Web SDK for more information.

uiOptions · UIOptions

UI configuration options.

ambientOptions · AmbientOptions

Ambient session configuration options.