API Changelog

​

Enhancements

• Suki now supports Single Auth Token authentication: your backend can use one shared partner_token for all clinicians instead of a per-user token. The shared token proves your organization is authorized, but it does not identify who is signed in. If you use this model, you must send sdp_provider_id on every API call so Suki can route each call to the correct clinician.

{
    "sdp_suki_token": "your-suki-token", // sdp_suki_token required for all API calls
    // Required with Single Auth Token auth: send sdp_provider_id on Register, Login, and every API call
    "sdp_provider_id": "doc1234567890"
}

​

New endpoints

• Info endpoints: Added new endpoints to get the list of supported medication coding systems, dosage units, encounter relations, frequencies, medication timings, origins, and statuses.
  • GET /api/v1/info/orders/coding-systems
  • GET /api/v1/info/orders/dosage-units
  • GET /api/v1/info/orders/encounter-relations
  • GET /api/v1/info/orders/frequencies
  • GET /api/v1/info/orders/medication-timings
  • GET /api/v1/info/orders/origins
  • GET /api/v1/info/orders/statuses

​

Enhancements

• Medication orders: You can now send and retrieve medication orders for an ambient session and encounter using the following endpoints. Structured data endpoints: These endpoints return the structured data for an ambient session and encounter.
  • GET /api/v1/ambient/session//structured-data
  • GET /api/v1/ambient/session//encounter-structured-data
  Context API: This endpoint allows you to update the ambient session context with new EMR context and medication orders.
  • POST /api/v1/ambient/session//context
  Content API: This endpoint returns the content for an ambient session and encounter.
  • GET /api/v1/ambient/session//content
  • GET /api/v1/ambient/session//encounter-content

{
    "structured_data": {
        "orders": {
            "medication_orders": {
                "values": [
                    {
                        "drug_name": "Drug Name",
                        "status": "Status",
                        "medication_code": "Medication Code",
                        "medication_code_type": "Medication Code Type"
                    }
                ]
            }
        }
    }
}

​

New endpoints

• Audio streaming and download: We’ve added a new endpoint for audio streaming and download from ambient sessions. Stream or download the audio recording from an ambient session.
  • GET /api/v1/ambient/session//recording

​

Deprecated

• Multilingual support: The multilingual parameter is deprecated in the Create Ambient Session endpoint. When you call create ambient session API, the multilingual support is now set to true by default.

​

New endpoints

• Audio Dictation API: Added support for real-time audio transcription/dictation. Create dictation sessions, stream audio data, and end sessions to get final transcripts. This enables use cases like dictation, real-time captioning, and transcript generation.
  • POST /api/v1/transcription/session/create
  • POST /api/v1/transcription/session//end
  • GET /ws/transcribe

​

Enhancements

• Code examples: Added code examples in Python and TypeScript for all APIs, making it easier to integrate with the platform regardless of your preferred programming language.

​

New endpoints

• Info endpoints: Introduced three new info endpoints to provide supported enum values, helping you validate context data before submission and ensuring data consistency.
  • GET /api/v1/info/encounter-types
  • GET /api/v1/info/visit-types
  • GET /api/v1/info/provider-roles
• API reference guidelines: Added a new API reference guidelines page to help you understand API status tags, versioning, and documentation standards.

​

Enhancements

• Enhanced API documentation: Significantly restructured and enhanced API reference documentation for better developer experience, clearer organization, and improved discoverability.
• Problem-based charting guide: Completely rewritten the Problem-Based Charting (PBC) guide with a clearer structure and more detailed explanations of the processing pipeline.
• Audio streaming authentication: Added detailed authentication guidance for both browser and non-browser clients in the Audio streaming API reference documentation.
• Enhanced context support: Updated the Ambient session context APIs to support a new VisitContext schema, including fields like chief_complaint and visit_type. The provider context has also been enhanced to support provider_role.

​

Removed support

• SNOMED codes: SNOMED codes are no longer supported for the diagnosis context
• Paused state: Paused state is no longer supported for ambient sessions