Edit Note With Instructions

POST 
/edit-note-with-instructions

Edit the Nabla-generated clinical note following human-readable text instructions, to customize and have more control over its content and structure.

Request

application/json

Body

required

instructions stringrequired

Possible values: non-empty and <= 700 characters

Human-readable text instructions for editing the note. Instructions should be short and straightforward, providing clear direction such as "Include discussion about…", "Make note more concise", or "Remove parts about…". The instructions should help refine and adapt the note to the desired format and content without requiring lengthy or complex prompts.

note objectrequired
The Nabla-generated clinical note of the encounter.
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.
]
note_locale note_locale (string)required

Possible values: [ENGLISH_US, ENGLISH_UK, FRENCH_FR]

Locale of the note.

note_template core_api_note_template (string)required

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.

transcript_items object[]required
The same transcript that served to generate the note. This transcript provides essential context, especially when instructions involve capturing more details or detailing specific parts of the encounter.
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.
]
patient_context string

Possible values: <= 700 characters

The same patient context that served to generate the note, if any.

Responses

200

Patient instructions.

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.
]

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

Loading...