Skip to main content
Updated:From Mobile SDK v2.8.0 on iOS, you can call getEncounterInfo(emrEncounterId:) to see the shared notes for an EMR encounter. The response includes each note’s status and timestamps, the ambient sessions under that note, and which artifacts are available.Learn more in the Shared notes across products section.
The Suki Mobile SDK provides methods to check the processing status and retrieve the generated content of a session. Use these methods to track the progress of your session and retrieve the generated content after it has been completed. What will you learn? In this guide, you will learn how to:
  • Check the processing status of a session using the status(for:) method.
  • Retrieve generated content by calling the content(for:) method to get clinical note suggestions.
  • Retrieve the full transcript of the conversation using the transcript(for:) method.
  • Get structured data, such as generated diagnoses and entities, using the getStructuredData(for:) method.
  • List and read shared notes across products with getEncounterInfo(emrEncounterId:), listEncounterNotes(emrEncounterId:), getNoteContext(noteId:), getNoteContent(noteId:), getNoteStructuredData(noteId:), and encounterContent(encounterId:).
  • Submit user feedback on AI-generated content using the submitFeedback(_:for:onCompletion:) method, including both quantitative and qualitative data.
  • Handle asynchronous results using a completion handler for all retrieval methods.
  • Understand and adhere to constraints for submitting feedback, including providing feedback only once per entity type per session.
Before calling session-scoped methods, ensure the Mobile SDK is initialized and that you use a valid sessionId from an active or completed session. Note-level methods use the same token provider and take an EMR encounter id or noteId instead.

Retrieval guides

Choose a guide for the APIs you need after an ambient session ends.

Check Status and Retrieve Content

Check processing with status(for:), then retrieve the clinical note, transcript, and structured data for a sessionId.

Shared Notes Across Products

List notes for an EMR encounter and read shared note context, content, and structured data across Suki products.

Submit User Feedback

Submit quantitative ratings and optional comments on AI-generated content with submitFeedback.

FAQs

The content is not being generated because the session is not in a completed state or the session was too short. We require a minimum of 1 minute of audio to generate content. You must ensure that the session is in a completed state before retrieving the content.
The content is not being retrieved because the sessionId is not valid. You must ensure that you are using a valid sessionId from an active or completed session.
Check the status of the session to determine if the content has been generated.
Check the status of the session to determine if the content has been retrieved.
If the internet connection is lost, the content will be retrieved when the connection is restored. Please refer to the Offline mode guide for more information.
The content will not be retrieved if the session is not completed. You must ensure that the session is in a completed state before retrieving the content.

Verify your integration

After you complete your first ambient session, verify that you can:
  • Check the session status with status(for:) and confirm processing is complete.
  • Retrieve the clinical note with content(for:) and the transcript with transcript(for:).
  • Access structured data, such as diagnoses and entities, with getStructuredData(for:).

Next steps

Clear session - Guide to create a new session.
Last modified on October 16, 2026