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_objectsdigest_output_object (string)[]required

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.

Possible values: [note]

languagecopilot_language (string)required
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).
Possible values: [fr, en, en-US, en-GB, fr-FR, es-ES, es-MX]
Example: en-US

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](/2024-04-22/server/copilot-listen-ws) 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 [

textstringrequired

The transcribed text.

Example: Also, I’m allergic to peanuts.

speakercopilot_speaker (string)required

Who said the text in this transcript item.

Possible values: [doctor, patient, unspecified]

Example: doctor

]

section_stylecopilot_section_style (string)
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.
Possible values: [auto, paragraphs, bullet_points]
Example: paragraphs
split_by_problemcopilot_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).
Default value: false
note_templatecopilot_note_template (string)
The desired template of the generated note.
Some templates are only available in specific languages. Check Note template for details.
Possible values: [GENERAL_MEDICINE, GENERAL_MEDICINE_AP_MERGED, CARDIOLOGY, PSYCHIATRY, DIET, PSYCHOLOGY, SOAP, GENERAL_MEDICINE_WCC, SOAP_WCC, GENERAL_MEDICINE_EMERGENCY, SOAP_EMERGENCY]
Example: GENERAL_MEDICINE
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 [

keycopilot_note_section_key (string)required

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.

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]

Example: CHIEF_COMPLAINT

titlestringrequired

The section title.

Example: Chief complaint

textstring

Content of the note section (required).

Example: Sleep disorder

]

patient_contextstring

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

Possible values: <= 700 characters

callback_urlstringrequired

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_idcopilot_client_request_id (string)

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.

Possible values: <= 128 characters

Responses

200

Request received and processing started.

application/json

Schema

Schema

request_iduuidrequired
The id of the request you just created.
Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6
client_request_idstring

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_iduuidrequired
The id of the async request.
Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6
client_request_idstring
The client_request_id provided in the request.
note
object
required
The generated note.
titlestring
Title of the note.
Example: Fever and strong headache
sections
object[]
required
Content of the note structured in multiple sections.
Array [
keycopilot_note_section_key (string)required
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.
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]
Example: CHIEF_COMPLAINT
titlestringrequired
The section title.
Example: Chief complaint
textstringrequired
Content of the note section.
Example: Sleep disorder
]
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`).
iduuidrequired
Unique identifier of the Dot Phrase.
titlestringrequired
A user-friendly title for the Dot Phrase. Does not impact the matching logic.
Example: Normal physical exam
triggerstringrequired
The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.
Example: Your physical exam is normal
content_auto_update_enabledbooleanrequired
If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.
Example: false
replacementstringrequired
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.
Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.
note_section
object
keycopilot_note_section_key (string)required
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.
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]
Example: CHIEF_COMPLAINT
titlestringrequired
Section title.
Example: Assessment & Plan.
text_to_insertstringrequired
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.
Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.
]
error
request_iduuidrequired
The id of the async request.
Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6
client_request_idstring
The client_request_id provided in the request.
error_codeintegerrequired
Example: 422
error_messagestring
Example: We can't generate the note when the transcript is too short.