Generate a note

POST 
/generate-note

Generate a structured clinical note given the transcript.

Request

application/json

Body

required

note_localecopilot_note_locale (string)required
Locale of the note.
Possible values: [en-US, en-GB, fr-FR]
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 its results 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

]

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_sections_customization

object[]

Advanced per-section customization options for the chosen template. You should **only specify sections that belong to the given template**, and **only specify customization options that are supported for the given section**. Also, only specify sections you want to customize, no need to be exhaustive. Check [Note templates sections](/2024-04-22/guides/note-templates-sections#per-section-customization-options) for compatibility matrix.

Array [

section_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

stylecopilot_note_section_customization_section_style (string)

Specifies the desired style for the note section:

• PARAGRAPH: 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, PARAGRAPH, BULLET_POINTS]

Example: PARAGRAPHS

level_of_detailcopilot_note_section_customization_level_of_detail (string)

Specifies the desired level of details. Use detailed to get more details in the note section.

Possible values: [DEFAULT, DETAILED]

split_by_problemboolean

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

]

previous_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 might 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

Responses

200

The generated note.

application/json

Schema

Schema

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.

]

Example (from schema)

{
  "note": [
    {
      "key": "CHIEF_COMPLAINT",
      "title": "Chief complaint",
      "text": "Fatigue and headaches"
    },
    {
      "key": "SYMPTOMS",
      "title": "Symptoms",
      "text": "- Tiredness all day long\n- Mild headaches on the right side"
    }
  ],
  "suggested_dot_phrases": [
    {
      "dot_phrase": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "title": "Normal physical exam",
        "trigger": "Your physical exam is normal",
        "content_auto_update_enabled": false,
        "replacement": "- 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": {
        "key": "CHIEF_COMPLAINT",
        "title": "Assessment & Plan."
      },
      "text_to_insert": "- Heart Examination: Normal, with regular rate and rhythm, no murmurs.\n- Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi.\n- Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.\n"
    }
  ]
}