Generate patient instructions

POST 
/generate-patient-instructions

Generates post-visit instructions for the patient. This extracts and summarizes the instructions the healthcare provider gave to the patient during the encounter.

Request

application/json

Body

required

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)

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.

instructions_locale speech_locale (string)required

Possible values: [ENGLISH_US, ENGLISH_UK, SPANISH_ES, SPANISH_MX, FRENCH_FR, ARABIC_EG, ARABIC_LB, ARABIC_MA, ARABIC_SA, ARMENIAN_AM, BENGALI_IN, CANTONESE_CN, CROATIAN_HR, FILIPINO_PH, GERMAN_DE, GREEK_GR, GUJARATI_IN, HEBREW_IL, HINDI_IN, ITALIAN_IT, JAPANESE_JP, KHMER_KH, KOREAN_KR, MANDARIN_CN, PERSIAN_IR, POLISH_PL, PORTUGUESE_PT, PUNJABI_IN, RUSSIAN_RU, SERBIAN_RS, TAMIL_IN, TELUGU_IN, THAI_TH, URDU_IN, VIETNAMESE_VN]

The spoken or written locale of the transcript, representing both the language and its specific regional variant.

recipient_type copilot_patient_instructions_recipient_type (string)

Possible values: [PATIENT, PARENT]

Default value: PATIENT

Recipient type of the patient instructions. This is especially useful for pediatric encounters.

Responses

200

Patient instructions.

application/json

Schema

Schema

instructions stringrequired

List of instructions for the patient.

Example (from schema)

{
  "instructions": "- Order a sleep test that you can do at home. This will help us understand more about how you sleep.\n- After you've done the sleep test, we'll talk about the results in our next meeting."
}

Loading...