Skip to main content
Shared notes across products let you build visit-level screens for providers on iOS, such as a list of notes for the EMR encounter, each note’s status, and which artifacts are ready. After a provider picks a note, you can load its content, context, or structured data in your app, including notes that were started in another Suki product for the same visit. Pass the same EMR encounter id you set as SukiAmbientConstant.kEmrEncounterId when you create the session. Use getEncounterInfo or listEncounterNotes to get noteId values, then call the note-level methods.

How to list and read shared notes

status(for:), content(for:), transcript(for:), and getStructuredData(for:) retrieve the processing status or generated content for a single ambient recording session. Each method requires a sessionId. To list or retrieve clinical notes shared across Suki products, use the note read APIs described below. Depending on the API, pass one of the following:
  • An EMR encounter id.
  • A noteId.
  • The Ambient API encounter_id (the same value you pass as kSessionId) as encounterId for encounterContent.
All of these APIs are asynchronous, and their completion handlers are invoked on the main queue. Errors are returned as generic or gRPC errors, not SukiStatus. These APIs use the same token provider configured for the ambient session APIs. For more information, refer to Ambient interoperability.
  • Call getEncounterInfo(emrEncounterId:) when you need to see the notes for an EMR visit, including each note’s status, timestamps, sessions, and available artifacts.
  • Call listEncounterNotes(emrEncounterId:) when you only need noteId values. Both APIs take the same EMR encounter id you pass as SukiAmbientConstant.kEmrEncounterId when you create the session.

Note read methods

The following are the note read methods supported by the Mobile SDK.
method
Returns an overview of the shared notes for an EMR encounter. Use this when you need note status, sessions, and available artifacts before you call note-level or session-level retrieve APIs.
method
Lists notes for an EMR encounter so you can discover shared notes across products.
method
Reads note-level context for a shared clinical note.
method
Reads note content (suggestions) for a shared clinical note.
method
Reads structured note data for a shared clinical note.
method
Reads encounter-level content for the Ambient API encounter_id. This is not an EMR encounter lookup.

Note read method signatures

The following are the method signatures for the note read APIs in the Mobile SDK.
Swift

Encounter info types

Swift

Get encounter info

Swift

List encounter notes and get note content

Swift

Get note content after encounter info

Swift

Next steps

Session status and content retrieval - overview of all retrieval workflows. Ambient interoperability - Conflict handling and shared encounter setup. Check status and retrieve content - Session-scoped status, note, transcript, and structured data APIs.
Last modified on October 16, 2026