Load supported LOINCs, specialties, visit types, provider roles, diagnosis code types, and medication order metadata for pickers and validation before you send ambient session context
Quick summary
Suki Info APIs provide catalogs of values supported for ambient session context and Medication order context.
Use these APIs to discover supported values, populate UI controls, or validate values before you send context through seed or update. Info catalogs list what Suki accepts. They do not apply values to a session for you.
Suki Info APIs provide catalogs of values supported by Suki for ambient session context and Medication order context.
Use these APIs when your application needs to discover supported values, populate UI controls, or validate values before sending context to Suki.
Info APIs tell you what values are supported. They do not apply those values to an ambient session.After your application selects the values it needs, send them through Provide visit context or Add information during a visit to apply them to the ambient session.
Build pickers and dropdowns from Suki-supported values.
Validate context values before sending them to Suki.
Keep medication order fields aligned with supported metadata.
Load supported LOINC section codes for note-section mappings.
Avoid maintaining hard-coded lists of supported values in your application.
Info APIs support context preparation. They are not a replacement for the ambient session workflow. You still use the appropriate APIs to create the session, stream audio, end the session, and retrieve ambient content.
There are three common ways to use these catalogs.
Build UI Pickers
Load the relevant catalog and use its values to populate your application’s UI.For example, use Supported LOINCs to build a note-section picker instead of maintaining a separate list of LOINC values in your application.Similarly, use the specialty, visit type, encounter type, and provider role catalogs when your application exposes those fields.
Validate Context
If your application receives context from another system or accepts values through user input, validate those values against the relevant Info catalog before calling Provide visit context or Add information during a visit.This lets your application identify unsupported values before sending the context.
Prepare Medication Order Context
Medication order context uses supported metadata for fields such as:
Coding systems
Dosage units
Frequency types
Medication timings
Order statuses
Order origins
Encounter relations
Use Medication order metadata when you need these catalogs together, or use an individual medication order Info API when you only need one category.See Medication orders for how medication orders fit into the ambient workflow.
It is important to keep these two concepts separate.
Info catalogs
Session context
Describe values supported by Suki
Contains values that apply to a specific session
Used to populate UI or validate values
Sent to Suki for the session
Retrieved through Info APIs
Sent through seed or update context APIs
Do not modify an ambient session
Provides context for the ambient session
For example, loading the supported specialties does not set a specialty on an ambient session. Your application must select the appropriate specialty and send it as session context.
If your application uses the same catalogs repeatedly, you can cache the responses and reuse them for pickers and validation.Choose a refresh strategy that fits your application. Refresh your cached values when you need to pick up changes to supported values, or when your application needs to use newly supported values.
You do not need to fetch an Info catalog before every ambient session if your application already has a cached copy of the catalog it needs.
Use Supported LOINCs to retrieve supported LOINC section codes and display names for note-section pickers and validation.If the LOINC values returned by the Info API differ from the static table in Note sections, use the Info API values. The API represents the supported values.
Use Supported diagnosis codes when your application needs the supported diagnosis code types for diagnosis context.
Medication Order Metadata
Use Medication order metadata when your application needs multiple medication order catalogs.Use the dedicated medication order routes when you only need a specific category, such as coding systems, dosage units, frequencies, timings, statuses, origins, or encounter relations.
A catalog can contain many supported values, but only the values that apply to the current visit should be sent as session context.Load the full catalog for pickers or validation. Send only the clinician’s selections on seed or update.
Treating the Note Sections Table as Source of Truth
When the static Note sections documentation and Supported LOINCs differ, use the values returned by the Info API.The concept guide is illustrative. The LOINC Info API represents the supported values Suki accepts today.
Requiring a Catalog Fetch Before Every Session
Info APIs support context preparation. They are not a replacement for the APIs used to create, stream, end, or retrieve content from an ambient session.Your application can use cached catalog values when appropriate. Do not block Create, Stream, End, or content retrieval on a fresh Info API call when you already have the catalogs you need.
Use the returned values to build your application’s note-section UI or validation logic. When the clinician selects a section, send the selected value through your ambient session context workflow.