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.
2024-10-01โ
- 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}
.
2024-06-12โ
- 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.
2024-06-03โ
- /generate_normalized_data endpoints now also return vitals, along with their LOINC codes, in the
observations
array.
2024-05-25โ
- Add an optional
reply_to
email field in the Feedback Report endpoint.
2024-05-16โ
- 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.
2024-05-13โ
- Add a new endpoint to fetch a user with a unique external ID from another system.
2024-05-06โ
- 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.
2024-05-02โ
- 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.
2024-04-23โ
- 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
2024-04-18โ
- Add new endpoints to manage Dot Phrases for a user.
- Suggest user's matching Dot Phrases alongside the generated note in the Digest endpoint.
2024-04-11โ
- Add four new templates:
GENERAL_MEDICINE_WCC
,SOAP_WCC
,GENERAL_MEDICINE_EMERGENCY
,SOAP_EMERGENCY
.
2024-04-03โ
- Add a new
/dictate
WebSocket endpoint for transcribing medical dictation.
2024-03-27โ
- Add a
patient_context
property indigest
anddigest_async
requests body
2024-03-25โ
- Implement the
/generate_patient_instructions
endpoint to generate a patient-friendly summary from an encounter.
2024-02-27โ
- New API version:
2024-02-27
. - Remove note generation feature from Listen Websocket API (no more usage of this deprecated feature).
2024-01-31โ
- 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.
2024-01-24โ
- Deprecate note generation feature in Listen Websocket API (recommend using the dedicated endpoint).
2024-01-17โ
- Add new endpoints: activate-user & deactivate user.
2023-12-01โ
- Deprecate
[es-ES, es-MX]
as note generation languages in Copilot API for digest and listen endpoints.
2023-11-14โ
- Add optional
client_request_id
parameter to/digest
and/digest_async
endpoints.