APIs Changelog

​

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 transcription API: Added support for real-time audio transcription. Create transcription sessions, stream transcription 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 SDP 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