After submitting an ambient session, Suki generates a clinical note in the background. Once ready, you can retrieve the note content and save it to your EHR.
You can receive note content using either the onNoteSubmit prop (React only) or the note-submission:success event (React and JavaScript). The SDK provides the note ID, contents organized by sections, and LOINC codes for each section.
Overview
After submitting an ambient session, Suki generates a clinical note in the background. Once ready, you can retrieve the note content and save it to your EHR.
Note Generation
Note generation happens automatically after session submission. Generation time depends on connectivity:
- Online: Faster generation since audio is processed in real-time during the conversation
- Offline: Slower generation since the entire audio file must upload first after connection is restored
For more details, see the offline mode guide.
Receiving Note Content
When a note is successfully submitted, the SDK provides the note content to your application. You can receive it using either method:
onNoteSubmit prop (React only, recommended)note-submission:success event (React and JavaScript)
const unsubscribeNoteSubmission = sdkClient.on("note-submission:success", (note) => {
console.log("Note ID:", note.noteId);
console.log("Note contents:", note.contents);
// Save to your EHR
note.contents.forEach((section) => {
console.log(`Section: ${section.title}`);
console.log(`Content: ${section.content}`);
console.log(`LOINC Code: ${section.loinc_code}`);
});
});
import { useSuki } from "@suki-sdk/react";
import { useCallback } from "react";
const { on } = useSuki();
useEffect(() => {
const unsubscribeNoteSubmission = on("note-submission:success", (note) => {
console.log("Note submitted:", note);
});
return () => unsubscribeNoteSubmission();
}, [on]);
const handleNoteSubmit = useCallback((note) => {
console.log("Note ID:", note.noteId);
// Save to your EHR
note.contents.forEach((section) => {
console.log(`Section: ${section.title} - ${section.content}`);
if (section.diagnosis) {
console.log(`Diagnosis: ${section.diagnosis.icdDescription}`);
}
});
}, []);
return (
<SukiAssistant
onNoteSubmit={handleNoteSubmit}
// other props
/>
);
Response Structure
When a note is successfully submitted, you receive a response object with the following structure:
{
"noteId": "82467ba8-71bc-46e2-8232-20d4d5629973",
"contents": [
{
"title": "History",
"content": "The patient is a 50-year-old female who has been experiencing fever for the last 10 days...",
"loinc_code": "18233-4",
"diagnosis": null
},
{
"title": "Review of Systems",
"content": "- No additional symptoms or pertinent negatives discussed during the encounter.",
"loinc_code": "10164-2",
"diagnosis": null
},
{
"title": "Assessment and Plan",
"content": "Viral hepatitis B with hepatic coma",
"loinc_code": "51847-2",
"diagnosis": {
"icdCode": "B19.11",
"icdDescription": "Unspecified viral hepatitis B with hepatic coma",
"snomedCode": "26206000",
"snomedDescription": "Hepatic coma due to viral hepatitis B",
"hccCode": "HCC-1",
"panelRanking": 1,
"billable": true,
"problemLabel": "Unspecified viral hepatitis B with hepatic coma"
}
}
]
}
Response Fields
Unique identifier for the generated note
Array of note sections. Each section contains:
title: Section title (e.g., “History of Present Illness”)content: Section content in plain textloinc_code: LOINC code for the section (optional)diagnosis: Diagnosis information if applicable (optional). Refer to Diagnosis for complete structure.
Next Steps
