Generate patient instructions

POST 
https://api.nabla.com/v1/copilot-api/server/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.

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

]

note_localecopilot_note_locale (string)required
Locale of the note.
Possible values: [en-US, en-GB, fr-FR]
Example: en-US
instructions_localecopilot_speech_locale (string)required
Locale of the patient instructions.
Possible values: [en-US, en-GB, fr-FR, es-ES, es-MX]
Example: en-US
recipient_typecopilot_patient_instructions_recipient_type (string)
Recipient type of the patient instructions. This is especially useful for pediatric encounters.
Possible values: [PATIENT, PARENT]
Default value: PATIENT
Example: PATIENT

Responses

200

application/json

Schema

Schema

instructionsstringrequired
List of instructions for the patient.
Example: - Order a sleep test that you can do at home. This will help us understand more about how you sleep. - After you've done the sleep test, we'll talk about the results in our next meeting.

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

Authorization: http

name: bearertype: httpscheme: bearer

• curl
• python
• go
• nodejs

• CURL

curl -L 'https://api.nabla.com/v1/copilot-api/server/generate_patient_instructions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "note": {
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Sleep disorder"
      }
    ]
  },
  "note_locale": "en-US",
  "instructions_locale": "en-US",
  "recipient_type": "PATIENT"
}'

Request Collapse all

Base URL

https://api.nabla.com/v1/copilot-api/server

Auth

Bearer Token

Body required

{
  "note": {
    "sections": [
      {
        "key": "CHIEF_COMPLAINT",
        "title": "Chief complaint",
        "text": "Sleep disorder"
      }
    ]
  },
  "note_locale": "en-US",
  "instructions_locale": "en-US",
  "recipient_type": "PATIENT"
}

ResponseClear

Click the Send API Request button above and see the response here!