Generate a note

POST 
/generate-note

Generate a structured clinical note given the transcript.

Request

application/json

Body

required

note_locale note_locale (string)required

Possible values: [ENGLISH_US, ENGLISH_UK, FRENCH_FR]

Locale of the note.

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 its results 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_type core_api_speaker (string)required
Possible values: [DOCTOR, PATIENT, UNSPECIFIED]
Who said the text in this transcript item.
]
note_template core_api_note_template (string)

Possible values: [GENERIC_MULTIPLE_SECTIONS, GENERIC_MULTIPLE_SECTIONS_AP_MERGED, GENERIC_SOAP, CARDIOLOGY_MULTIPLE_SECTIONS, PSYCHIATRY_MULTIPLE_SECTIONS, DIET_MULTIPLE_SECTIONS, PSYCHOLOGY_MULTIPLE_SECTIONS, WCC_MULTIPLE_SECTIONS, WCC_SOAP, EMERGENCY_MULTIPLE_SECTIONS, EMERGENCY_SOAP]

The desired template of the generated note.

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

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 for compatibility matrix.
Array [
section_key core_api_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISK_FACTORS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, FOOD_HABITS, LIFESTYLE, PAST_MEDICAL_HISTORY, OBJECTIVES_AND_ADVICE, 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, HISTORY_OF_PRESENT_COMPLAINT, OBJECTIVE, SUBJECTIVE, SOCIAL_HISTORY, VITALS, WELL_CHILD_CARE]
Key of the note section this customization should apply to.
custom_instruction copilot_note_section_customization_custom_instruction (string)
Allow to customize a note section by providing specific guidelines. These guidelines must be as clear and concise as possible for best results.
style copilot_note_section_customization_section_style (string)
Possible values: [AUTO, PARAGRAPH, BULLET_POINTS]
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.
level_of_detail copilot_note_section_customization_level_of_detail (string)
Possible values: [DEFAULT, DETAILED]
Specifies the desired level of details. Use detailed to get more details in the note section.
split_by_problem boolean
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.
title string
Title of the note.
sections object[]required
Sections of the note.
Array [
key core_api_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISK_FACTORS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, FOOD_HABITS, LIFESTYLE, PAST_MEDICAL_HISTORY, OBJECTIVES_AND_ADVICE, 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, HISTORY_OF_PRESENT_COMPLAINT, OBJECTIVE, 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.
]
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].

Responses

200

The generated note.

application/json

Schema

Schema

note objectrequired
The generated note.
title string
Title of the note.
sections object[]required
Content of the note structured in multiple sections.
Array [
key core_api_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISK_FACTORS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, FOOD_HABITS, LIFESTYLE, PAST_MEDICAL_HISTORY, OBJECTIVES_AND_ADVICE, 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, HISTORY_OF_PRESENT_COMPLAINT, OBJECTIVE, 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 core_api_note_section_key (string)required
Possible values: [ALLERGIES, APPOINTMENTS, ASSESSMENT, ASSESSMENT_AND_PLAN, CARDIOVASCULAR_RISK_FACTORS, CHIEF_COMPLAINT, CURRENT_MEDICATIONS, FOOD_HABITS, LIFESTYLE, PAST_MEDICAL_HISTORY, OBJECTIVES_AND_ADVICE, 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, HISTORY_OF_PRESENT_COMPLAINT, OBJECTIVE, 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.
]

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"
    }
  ]
}

Loading...