Check Status and Retrieve Content

Check status and retrieve content lets you track when an ambient session finishes processing and pull the clinical note, transcript, and structured data for that sessionId.

Check status and retrieve content

After you end a session, asynchronously check its processing status and retrieve the generated content. You must provide a valid sessionId for the session you want to query. The diagram below illustrates the process of retrieving the generated content of a session. All retrieval methods are asynchronous. The result is returned in a , which provides either the requested content or an error.

Check the processing status

Call status(for:) after a session ends to check whether Suki has finished processing the audio. The clinical note, transcript, and structured data are only available once processing is complete, so use this method to decide when to call the retrieval methods and to drive a “processing” or “note ready” state in your UI. Suki needs at least one minute of audio to generate content. If a session was too short or is not yet complete, the status reflects that, and the retrieval methods return no content.

SukiAmbientCoreManager.shared.status(for: sessionId) { result in
    // The completion handler returns a result type.
    switch result {
    case .success(let status):
        // On success, the status object contains the current state.
        print("Session status: \(status)")
    case .failure(let error):
        // On failure, an error object is returned.
        print("Error fetching status: \(error)")
    }
}

Get generated suggestions

Call content(for:) to retrieve the AI-generated clinical note: the suggestions your provider reviews, edits, and signs before handoff to the EHR. This is the primary output most integrations display after a visit. Call it only after status(for:) reports that processing is complete. Calling it earlier returns no content.

SukiAmbientCoreManager.shared.content(for: sessionId) { result in
    switch result {
    case .success(let suggestions):
        // The suggestions object contains the generated note content.
        print("Generated Suggestions: \(suggestions)")
    case .failure(let error):
        print("Error fetching content: \(error)")
    }
}

Get the audio transcript

Call transcript(for:) to retrieve the word-for-word text of the conversation, which is separate from the generated clinical note. Use it when you need exactly what was said rather than the summarized note, for example to let a provider verify the note against the transcript, support QA or compliance review, or display the transcript alongside the note. The response contains transcript segments. The example below joins them into a single string.

SukiAmbientCoreManager.shared.transcript(for: sessionId) { result in
    switch result {
    case .success(let response):
        // The response object contains transcript segments.
        // This example joins them into a single string.
        let transcriptText = (response.finalTranscript ?? []).compactMap { $0.transcript }.joined(separator: " ")
        print(transcriptText)
    case .failure(let error):
        print("Error fetching transcript: \(error)")
    }
}

Get structured data

Call getStructuredData(for:) when you need discrete, machine-readable output instead of free-text notes, for example to populate diagnosis fields, drive orders, support medical coding, or feed analytics in your application. It returns diagnoses and other entities generated from the session.

Starting with Mobile SDK v2.6.0, the response may include Medication orders when that capability is enabled for your integration. Medication orders are optional, so check for them before you use them, as shown below.

SukiAmbientCoreManager.shared.getStructuredData(for: sessionId) { result in
    switch result {
    case .success(let response):
        let data = response.structuredData
        // Diagnoses
        for d in data.diagnoses.diagnoses {
            print(d.note)
        }
        // Medication orders (optional) if Medication orders are enabled
        if let orders = data.orders?.medicationOrders {
            let all = orders.values + orders.partialValues
            for order in all {
                print(order.drugName, order.instructions)
            }
        }
    case .failure(let error):
        print(error)
    }
}

Next steps

Session status and content retrieval - overview of all retrieval workflows. Shared notes across products - List and read notes shared across Suki products. Clear session - Clear local session state after retrieve.

Get Started

Concepts & Feature Guides

Resources

Check Status and Retrieve Content