Generate patient instructions
POSThttps://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
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
- Example (from 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.
{
"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"
}'
ResponseClear