Generate a note asynchronously

POST 
/digest_async

Digests a list of transcript items and produces a structured clinical note.

Request

application/json

Body

required

output_objects digest_output_object (string)[]required

Possible values: [note]

Specifies which items you want us to send you back. In other words, which feature(s) you want to use, for now only note generation is available.

language copilot_language (string)required

Possible values: [fr, en, en-US, en-GB, fr-FR, es-ES, es-MX]

Language of the given transcript and the desired note ('fr' and 'en' are deprecated, and correspond to 'fr-FR' and 'en-US' respectively. Generating a note in 'es-ES' and 'es-MX' is not supported and will be soon removed).

transcript_items object[]required
The transcript from which to generate the note.
You don't need to specify each item's start or end time, but make sure they are sorted. In fact, due to its asynchronous nature, our real-time transcription API does not guarantee the order. Thus, before calling this note-generation API please filter-out non-final items and sort them by start_offset_ms.
Array [
text stringrequired
The transcribed text.
speaker copilot_speaker (string)required
Possible values: [doctor, patient, unspecified]
Who said the text in this transcript item.
]
section_style copilot_section_style (string)

Possible values: [auto, paragraphs, bullet_points]

Choose a desired style for note sections:

• paragraphs: Prioritizes generating paragraphs;

• bullet_points: Prioritizes structuring content using bullet points.

• auto: Automatically picks the most natural formatting option.

Default is auto.

split_by_problem copilot_split_by_problem (boolean)

Flag to structure the content of the note sections according to distinct clinical problems or topics addressed during the consultation.

When this flag is enabled, the text within some sections of the clinical note is organized into subsections, each corresponding to a specific problem or topic. This format aims to enhance the clarity and organization of the clinical note, making it easier to read and understand the different issues discussed during the consultation.

Important: Currently, the application of this flag is limited to the HISTORY_OF_PRESENT_ILLNESS and SOAP_SUBJECTIVE sections and is only effective when the language is set to English (US or GB).

note_template copilot_note_template (string)

Possible values: [GENERAL_MEDICINE, GENERAL_MEDICINE_AP_MERGED, CARDIOLOGY, PSYCHIATRY, DIET, PSYCHOLOGY, SOAP, GENERAL_MEDICINE_WCC, SOAP_WCC, GENERAL_MEDICINE_EMERGENCY, SOAP_EMERGENCY]

The desired template of the generated note.

Some templates are only available in specific languages. Check Note template for details.

note object
Optional initial Note to be enhanced using the new transcript_items. This is useful if you generate notes gradually to avoid accumulating a very long transcript items list. Typically, this will be the last note Nabla generated for you along with the new transcript_items that did not serve for its generation. Important: This is expected to be a recent (up to few-hours old) Nabla-generated note. If the note is too old or altered, you will get an error.
sections object[]required
Sections of the note.
Array [
key copilot_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISKS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, DIET_APPOINTMENTS, DIET_CHIEF_COMPLAINT, DIET_HABITS, DIET_LIFESTYLE, DIET_MEDICAL_HISTORY, DIET_OBJECTIVES, DIET_VITALS, FAMILY_HISTORY, HISTORY_OF_PRESENT_ILLNESS, IMAGING_RESULTS, IMMUNIZATIONS, LAB_RESULTS, MENTAL_HEALTH_EXAM, MENTAL_HEALTH_HISTORY, PAST_MEDICAL_HISTORY, PAST_OBSTETRIC_HISTORY, PAST_SURGICAL_HISTORY, PHYSICAL_EXAM, PLAN, PRESCRIPTION, PSYCHOLOGY_HISTORY_OF_COMPLAINT, SOAP_ASSESSMENT, SOAP_OBJECTIVE, SOAP_PLAN, SOAP_SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
A key identifying a section of a note. The set of possible keys depend on the template that is used. Check Note template for possible values.
title stringrequired
The section title.
text string
Content of the note section (required).
]
patient_context string

Possible values: <= 700 characters

Some contextual information that will be used to generate the note (for example name, gender, age, pronouns, medical history) [BETA].

callback_url stringrequired

Once we are done processing the input and generating the note, we will call you back with a 'POST' on this URL and a Json body respecting exactly the same schema as the response of the synchronous equivalent endpoint (i.e. /copilot/digest).

client_request_id copilot_client_request_id (string)

Possible values: <= 128 characters

An optional unique client-made id for this request. When specified, this id is included in the Json payload that will be sent asynchronously. This can help clients both guarantee idempotency and correlate asynchronous responses with their requests.

Note: this id must be different for every request. It is recommended to use a randomly generated UUID.

Responses

200

Request received and processing started.

application/json

Schema

Schema

request_id uuidrequired

The id of the request you just created.

client_request_id string

The provided client_request_id.

Example (from schema)

{
  "request_id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "client_request_id": "string"
}

299

Here's the schema of the Json payload that will be sent asynchronously to the URL you provided. (299 is not a possible response code — only a way here to document the asynchronous payload schema).

application/json

Schema

Schema

oneOf
success
request_id uuidrequired
The id of the async request.
client_request_id string
The client_request_id provided in the request.
note objectrequired
The generated note.
title string
Title of the note.
sections object[]required
Content of the note structured in multiple sections.
Array [
key copilot_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISKS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, DIET_APPOINTMENTS, DIET_CHIEF_COMPLAINT, DIET_HABITS, DIET_LIFESTYLE, DIET_MEDICAL_HISTORY, DIET_OBJECTIVES, DIET_VITALS, FAMILY_HISTORY, HISTORY_OF_PRESENT_ILLNESS, IMAGING_RESULTS, IMMUNIZATIONS, LAB_RESULTS, MENTAL_HEALTH_EXAM, MENTAL_HEALTH_HISTORY, PAST_MEDICAL_HISTORY, PAST_OBSTETRIC_HISTORY, PAST_SURGICAL_HISTORY, PHYSICAL_EXAM, PLAN, PRESCRIPTION, PSYCHOLOGY_HISTORY_OF_COMPLAINT, SOAP_ASSESSMENT, SOAP_OBJECTIVE, SOAP_PLAN, SOAP_SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
A key identifying a section of a note. The set of possible keys depend on the template that is used. Check Note template for possible values.
title stringrequired
The section title.
text stringrequired
Content of the note section.
]
suggested_dot_phrases object[]
A collection of Dot Phrases that were successfully matched to the encounter's transcript, given the Dot Phrases defined on the calling user. Will be null in the context of a Server API call (i.e. no calling user). This functionality enriches the generated note by expanding concise key sentences (triggers) into a more detailed format following the given Dot Phrase definition. Thus, enhancing the depth and utility of the note and facilitating a comprehensive review of patient assessments in a structured and conventional manner.
Array [
dot_phrase object
Dot phrase, also referred to as EHR (Electronic Health Record) macro, is a concise abbreviation (trigger) that unfolds into a predefined, extended text (replacement).
id uuidrequired
Unique identifier of the Dot Phrase.
title stringrequired
A user-friendly title for the Dot Phrase. Does not impact the matching logic.
trigger stringrequired
The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.
content_auto_update_enabled booleanrequired
If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.
replacement stringrequired
The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.
note_section object
The key and the title of the section in the note where this Dot Phrase is suggested to go. There are three possible scenarios:
• No suggested section: Given the Dot Phrase's content, we found no appropriate section to suggest. You should decide for a default (for instance: any kind of "free text" area you might have).
• Suggested section already present in the note: We recommend you append the Dot Phrase's suggested text_to_insert to the section's content.
• Suggested section is not present in the note: Add a new section to the note with the provided key and title and use the Dot Phrase's suggested text_to_insert as the section's content.
key copilot_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISKS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, DIET_APPOINTMENTS, DIET_CHIEF_COMPLAINT, DIET_HABITS, DIET_LIFESTYLE, DIET_MEDICAL_HISTORY, DIET_OBJECTIVES, DIET_VITALS, FAMILY_HISTORY, HISTORY_OF_PRESENT_ILLNESS, IMAGING_RESULTS, IMMUNIZATIONS, LAB_RESULTS, MENTAL_HEALTH_EXAM, MENTAL_HEALTH_HISTORY, PAST_MEDICAL_HISTORY, PAST_OBSTETRIC_HISTORY, PAST_SURGICAL_HISTORY, PHYSICAL_EXAM, PLAN, PRESCRIPTION, PSYCHOLOGY_HISTORY_OF_COMPLAINT, SOAP_ASSESSMENT, SOAP_OBJECTIVE, SOAP_PLAN, SOAP_SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
A key identifying a section of a note. The set of possible keys depend on the template that is used. Check Note template for possible values.
title stringrequired
Section title.
text_to_insert stringrequired
The actual suggested content, to be inserted in the corresponding note section. Please note that the content might be different from the replacement in the original Dot Phrase definition. In fact, the text_to_insert takes into account the contextual information of the encounter and might change the original Dot Phrase replacement text, for instance to include exceptions.
]
error
request_id uuidrequired
The id of the async request.
client_request_id string
The client_request_id provided in the request.
error_code integerrequired
error_message string

Loading...