AmbientOptions Type

Configure ambient sessions with sections, diagnoses, visit context, and provider context through the AmbientOptions type

Updated

v2.2.0+ You can pass optional visit and provider context under visitContext and providerContext to improve note generation. Set these when you call mount or setAmbientOptions.

Use AmbientOptions when you configure an Ambient session. Pass sections and diagnoses you already know, plus visit and provider context when you have them.

JavaScript

type VisitContext = {
  visitType?: string; // Enum from Visit Types API
  encounterType?: string; // Enum from Encounter Types API
  reasonForVisit?: string; // Max 255 characters
  chiefComplaint?: string; // Max 255 characters
};

type ProviderContext = {
  providerRole?: string; // Enum from Provider Roles API
};

type AmbientOptions = {
  sections?: Section[];
  diagnoses?: {
    values: Array<{
      codes: Array<{ code?: string; description?: string; type: "ICD10" }>;
      diagnosisNote?: string;
    }>;
  };
  visitContext?: VisitContext;
  providerContext?: ProviderContext;
};

Set the EMR encounter UUID on encounter.identifier only. Do not put an emrEncounterId on ambientOptions. If encounter.identifier is set, that is what the SDK uses. See Encounter and Ambient interoperability.

Properties

sections · Section[]

Array of clinical note LOINC sections to generate.

diagnoses · object

Optional - Patient diagnoses you already know (for example from the EHR), used when Problem-Based Charting is enabled. Each diagnosis needs one ICD10 code. Use camelCase diagnosisNote. See Existing patient diagnoses.

visitContext · object

Optional - Visit details for this session. Nested object (not flat fields on ambientOptions).

Show visitContext fields

visitType · string

Visit type enum, for example NEW_PATIENT or ESTABLISHED_PATIENT. See Visit types. In the Web SDK UI, this value can set the note title in the patient note list.

encounterType · string

Setting of the encounter, for example AMBULATORY, INPATIENT, or ED.

reasonForVisit · string

Free-text reason for the visit. Maximum 255 characters.

chiefComplaint · string

Patient’s primary complaint. Maximum 255 characters.

providerContext · object

Optional - Provider details for this session.

Show providerContext fields

providerRole · string

Provider role enum, for example PRIMARY/ATTENDING or CONSULTING. See Provider roles.