Documentation Index
Fetch the complete documentation index at: https://docs.sully.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview
While Sully.ai can generate clinical notes from transcripts alone, providing additional context significantly improves note accuracy and completeness. Context enrichment helps Sully:- Personalize notes with correct patient demographics and pronouns
- Reference current medications in assessments and identify potential interactions
- Maintain continuity of care by understanding previous visits
- Follow your preferences for note structure and emphasis
- Incorporate external data like lab results or specialist recommendations
Available Context Fields
When creating notes, you can provide the following optional context fields:| Field | Type | Description |
|---|---|---|
date | string | Visit date (ISO format or natural language) |
patientInfo | object | Patient demographics (name, DOB, gender) |
medicationList | string[] | Current medications the patient is taking |
previousNote | string | Previous visit note for continuity of care |
instructions | string | Specific instructions for note generation |
context | string | Any additional free-form context |
Patient Info
ThepatientInfo object provides basic patient demographics that appear in the note header and inform pronoun usage throughout the document.
Structure
| Field | Type | Description |
|---|---|---|
name | string | Patient’s full name |
dateOfBirth | string | Date of birth (ISO format or natural language) |
gender | string | Patient’s gender (used for pronouns) |
How It’s Used
- Note header: Patient name and age derived from DOB appear at the top of the note
- Pronoun consistency: Gender informs pronoun usage (she/her, he/him, they/them)
- Age-appropriate language: Pediatric vs. adult clinical terminology
Code Example
Medication List
ThemedicationList field accepts an array of medication strings representing the patient’s current medications.
Format
Provide medications as strings. Include dosage information when available:How It’s Used
- Medication reconciliation: Referenced in the Subjective or History section
- Assessment context: Helps identify drug interactions or contraindications
- Plan decisions: Informs medication adjustments or additions
- Allergy considerations: Cross-referenced when new medications are discussed
Code Example
Previous Notes
ThepreviousNote field accepts the text of a previous visit note. This is particularly powerful for follow-up visits where continuity of care is important.
How It’s Used
- Continuity of care: References previous diagnoses, treatments, and recommendations
- Progress tracking: Notes improvement or worsening of conditions
- Follow-up references: “Patient returns for follow-up of…” language
- Treatment response: Documents how the patient responded to previous interventions
Best Use Cases
| Visit Type | Previous Note Value |
|---|---|
| Follow-up visit | Previous visit note for same condition |
| Post-procedure | Pre-procedure or procedure note |
| Chronic disease management | Most recent note for that condition |
| Hospital discharge follow-up | Discharge summary |
Code Example
For follow-up visits, providing the previous note is one of the most impactful context enrichments you can make. It enables Sully to generate notes that reflect the ongoing patient journey rather than treating each visit in isolation.
Custom Instructions
Theinstructions field accepts free-text instructions that guide how the note should be generated. Use this for specialty-specific requirements or personal preferences.
Example Instructions
| Use Case | Example Instruction |
|---|---|
| Specialty focus | ”Focus on cardiovascular symptoms and risk factors” |
| Format preference | ”Use bullet points for the assessment section” |
| Detail level | ”Keep the plan section brief with only essential items” |
| Compliance | ”Include ICD-10 codes for all diagnoses” |
| Style | ”Write in third person, past tense” |
How It’s Used
- Section emphasis: Guides which sections receive more detail
- Formatting preferences: Influences use of lists, paragraphs, headers
- Content inclusion: Ensures specific elements are captured
- Tone adjustment: Modifies clinical vs. patient-friendly language
Code Example
Free-form Context
Thecontext field accepts any additional information that doesn’t fit into the other structured fields. This is your catch-all for relevant clinical data.
Common Use Cases
- Lab results: Recent bloodwork, imaging findings
- Specialist recommendations: Notes from referrals
- Patient preferences: Treatment preferences, concerns
- Social context: Relevant life events, support system
- Historical data: Past surgical history, family history
Code Example
Complete Example
Here’s a full API call using all available context fields:Best Practices
Provide Context When Available
Every piece of context you provide improves note quality. Even partial information helps:| What You Have | What to Provide |
|---|---|
| Patient name only | patientInfo: { name: "..." } |
| Some medications | Provide what you know |
| Partial previous note | Better than nothing |
Avoid Unnecessary PHI
Only include PHI that should appear in the generated note:- Include: Patient name (if needed in header), relevant medical history
- Avoid: Social Security numbers, full addresses, insurance details
Use Instructions for Specialty Needs
Different specialties have different documentation requirements:| Specialty | Example Instructions |
|---|---|
| Cardiology | ”Include cardiovascular risk factor assessment” |
| Psychiatry | ”Document mental status exam findings in detail” |
| Pediatrics | ”Include developmental milestones and growth percentiles” |
| Surgery | ”Focus on surgical indications and planned procedure” |
Leverage Previous Notes for Follow-ups
For follow-up visits,previousNote provides the most value:
- Enables “Patient returns for follow-up of…” language
- Allows comparison of symptoms over time
- Documents treatment response
- Maintains diagnostic continuity
Next Steps
Create Note API
Full API reference for the Create Note endpoint
Clinical Notes Guide
Learn about SOAP notes, custom styles, and templates
Note Customization
Deep dive into styles and templates for precise control
Webhooks
Get notified when notes are ready