Changelog
Keeping track of changes
All changes are documented here. The following sections are not necessarily API version codes, most changes come without a new API version unless it is necessary for backward compatibility.
January 31, 2025
- Dictate Websocket must now be used with new protocol "dictate-protocol". (Previous protocol "copilot-dictate-protocol" remains supported for backward compatibility).
- The new protocol includes the following changes compared to previous one, with the aim of following the same conventions as transcription Websocket:
- New screaming snake case frame types:
dictate_config
->CONFIG
audio_chunk
->AUDIO_CHUNK
end
->END
dictation_item
->DICTATION_ITEM
error_message
->ERROR_MESSAGE
- More conventional configuration options:
- Audio encoding enum with capital letters (
pcm_s16le
->PCM_S16LE
) - Specify minimum value of 8000 and maximum value of 192000 for
sample_rate
- Rename locale property
locale
tospeech_locale
and add support for 35 values including various languages with regional dialects.
- Audio encoding enum with capital letters (
- New screaming snake case frame types:
January 23, 2025
- Add four new templates:
GENERIC_SOAP_AP_MERGED
,PSYCHIATRY_SOAP
,GENERIC_APSO_AP_MERGED
,GENERIC_SOAP_PLUS_EXAM_TESTS_AP_MERGED
.
January 7, 2025
- New
2025-01-07
API version. - All API endpoints must now be accessed with a regionalized URL (
us.api.nabla.com
oreu.api.nabla.com
). The defaultapi.nabla.com
is no longer supported. The usage of region specific host ensures optimal API response time.
December 23, 2024
- New
2024-12-23
API version. - All API endpoints must now be accessed through the new "core/server" or "core/user" paths.
December 3, 2024
- Remove unenforced property constraint from deprecated /digest and /digest_async endpoints.
November 22, 2024
- Add
custom_instruction
customization option to note generation endpoints.
November 18, 2024
- Promote the Transcription audio acknowledgement from experimental to public, it is now available for everyone to use.
November 13, 2024
- Fix Generate Server Access Token endpoint by accepting regionalized (prefixed with
us.
oreu.
) URLs inaud
claim of the JWT assertion.
November 8, 2024
- New
2024-11-08
API version. - Fixed case for server-to-client frames in Transcribe Websocket. It is now
SCREAMING_SNAKE_CASE
for all the frames, e.g.transcript_item
becomesTRANSCRIPT_ITEM
.
November 7, 2024
- New
/edit-note-with-instructions
endpoint to edit a note with human-readable free-text instructions.
October 1, 2024
- ** New
2024-10-01
major API version deprecating all prior versions. Check the Migration guide.** - Add support for OAuth Client authentication flow for server-to-server integrations.
- Add support for Webhooks with events sent upon completion of asynchronous tasks like asynchronous note generation.
- New transcription websocket with a simpler frames schema, and support for 35 languages.
- New note generation endpoint with per-section customization capabilities.
- New asynchronous note generation endpoint with the ability to poll the result through a polling endpoint.
- New transcription from file upload endpoint with a simpler body schema.
- New transcription from file upload endpoint with the ability to poll the result through a polling endpoint.
- Renaming of base URL to
/v1/core/server
and/v1/core/user
. - Support for direct URL to a specific geographical region, e.g.
us.api.nabla.com/*
instead of justapi.nabla.com/*
. - Removed or renamed endpoints (still supported on older versions for backward compatibility):
/digest
,/digest_async
,/listen
,/listen-ws
,/listen_async
,/generate_normalized_data
,/generate_patient_instructions
,/dot_phrases
&/dot_phrases/{id}
.
June 12, 2024
- Feedback Report endpoint now takes an
expected_output
field, so you can pass a structured version of what you expected the endpoint to give as output.
June 3, 2024
- /generate_normalized_data endpoints now also return vitals, along with their LOINC codes, in the
observations
array.
May 25, 2024
- Add an optional
reply_to
email field in the Feedback Report endpoint.
May 16, 2024
- Add new experimental audio chunk acknowledgement protocol with a detailed guide (requires opt-in).
- Add a new endpoint to send feedback or report issues directly related to specific API interactions.
May 13, 2024
- Add a new endpoint to fetch a user with a unique external ID from another system.
May 6, 2024
- Add a
content_auto_update_enabled
property on dot phrases in create, read and update user dot-phrases endpoints to automatically adapt dot-phrase replacement text to the context of the encounter.
May 2, 2024
- Add a
title
property in the note generated by server digest, server digest async, user digest and user digest async endpoints. The title is a short description of the note content.
April 23, 2024
- Add the
/generate_normalized_data
server and user endpoints to generate normalized data from a note. - Add
external_id
,metadata
andcreated_at
on User - Add a
/PATCH /users/:id
endpoint - New API version:
2024-04-22
. - Remove
upcoming_appointments_details
from the output of the /generate_patient_instructions endpoint. Upcoming appointments details are now included inside instructions starting for this version. - Remove
note_generation_mode
request property from digest and digest async endpoints
April 18, 2024
- Add new endpoints to manage Dot Phrases for a user.
- Suggest user's matching Dot Phrases alongside the generated note in the Digest endpoint.
April 11, 2024
- Add four new templates:
GENERAL_MEDICINE_WCC
,SOAP_WCC
,GENERAL_MEDICINE_EMERGENCY
,SOAP_EMERGENCY
.
April 3, 2024
- Add a new
/dictate
WebSocket endpoint for transcribing medical dictation.
March 27, 2024
- Add a
patient_context
property indigest
anddigest_async
requests body
March 25, 2024
- Implement the
/generate_patient_instructions
endpoint to generate a patient-friendly summary from an encounter.
February 27, 2024
- New API version:
2024-02-27
. - Remove note generation feature from Listen Websocket API (no more usage of this deprecated feature).
January 31, 2024
- Add new endpoints to fetch a single user or all users using filters and pagination.
- Add
split_by_problem
to digest & listen-from-file endpoints.
January 24, 2024
- Deprecate note generation feature in Listen Websocket API (recommend using the dedicated endpoint).
January 17, 2024
- Add new endpoints: activate-user & deactivate user.
December 1, 2023
- Deprecate
[es-ES, es-MX]
as note generation languages in Core API for digest and listen endpoints.
November 14, 2023
- Add optional
client_request_id
parameter to/digest
and/digest_async
endpoints.