Templates

Templates define the output structure of generated notes. Each template specifies headings, document type, and formatting rules. Scribeberry includes public templates for common note types (SOAP, H&P, Progress Notes), and you can create custom templates for your specialty.

List Templates

const { items, meta } = await sb.templates.list({
  page: 1,
  pageSize: 20,
});
 
for (const template of items) {
  console.log(`${template.name} — ${template.documentType}`);
  console.log(`  Headings: ${template.headings.join(', ')}`);
}

Parameters

Parameter	Type	Default	Description
`page`	`number`	`1`	Page number (1-indexed)
`pageSize`	`number`	`20`	Items per page (max 100)
`sortBy`	`string`	`name`	Field to sort by
`sortOrder`	`'asc' \| 'desc'`	`asc`	Sort direction

Response

interface PaginatedResponse<Template> {
  items: Template[];
  meta: {
    page: number;
    pageSize: number;
    totalPages: number;
    totalCount: number;
  };
}

Get a Template

const template = await sb.templates.get('template-id');
 
console.log(template.name);        // "SOAP Note"
console.log(template.documentType); // "soap"
console.log(template.headings);     // ["Subjective", "Objective", "Assessment", "Plan"]

Create a Template

Create a custom template for your organization:

const template = await sb.templates.create({
  name: 'Dermatology Visit Note',
  description: 'Structured note for dermatology consultations',
  documentType: 'visit_note',
  content: 'Template content or instructions...',
  headings: [
    'Chief Complaint',
    'History of Present Illness',
    'Skin Examination',
    'Assessment',
    'Treatment Plan',
  ],
  categories: ['dermatology', 'specialty'],
});

Delete a Template

await sb.templates.delete('template-id');

ℹ️ Info: You can only delete templates that belong to your project. Public templates provided by Scribeberry cannot be deleted.

Template Object

interface Template {
  id: string;
  name: string;
  description: string;
  documentType: string;       // "soap", "hp", "progress", etc.
  headings: string[];          // Section headings for the note
  categories: string[];        // Tags for filtering
  isPublic: boolean;           // true = Scribeberry-provided
  createdAt: string;           // ISO 8601
  updatedAt: string;           // ISO 8601
}

Common Document Types

Type	Description	Example Headings
`soap`	SOAP Note	Subjective, Objective, Assessment, Plan
`hp`	History & Physical	Chief Complaint, HPI, ROS, Physical Exam, Assessment, Plan
`progress`	Progress Note	Interval History, Examination, Assessment, Plan
`procedure`	Procedure Note	Indication, Procedure, Findings, Disposition
`discharge`	Discharge Summary	Admission Diagnosis, Hospital Course, Discharge Plan

On this page