Templates

A template decides the sections and style of a generated note. GET /templates lists every template your organization can use, so you can show them in your own product or pick one when you regenerate a note. It needs the notes:read scope. The list contains:

Built-in templates (type: "built_in"): the HealOS templates every organization has, such as SOAP.
Custom templates (type: "custom"): templates created in your organization and shared with it.

Private templates, which only one clinician can see, are not listed.

curl "https://api.healos.ai/ext-api/v1/templates?type=custom" \
  -H "X-API-Key: $HEALOS_API_KEY"

{
  "data": [
    {
      "id": "77777777-0000-0000-0000-000000000001",
      "name": "Follow-up Visit",
      "type": "custom",
      "document_type": "note",
      "description": "Subjective, Objective, Assessment, Plan",
      "sections": ["Subjective", "Objective", "Assessment", "Plan"],
      "includes_prior_visit": false
    }
  ],
  "meta": { "page": 1, "limit": 20, "total_pages": 1 }
}

Query	Description
`type`	`built_in` or `custom` to return only one kind. Omit for both.
`page`, `limit`	Pagination. `limit` defaults to 20, maximum 100.

Field	Description
`id`	Pass this as `template_id` when you regenerate a note.
`document_type`	`note` for clinical notes, `document` for letters and forms.
`description`	The template’s section titles, in order (null if it has none).
`sections`	The same section titles as a list.
`includes_prior_visit`	Whether notes from this template include the patient’s previous visit by default.

Getting Started

Resources

Templates

Templates

​Templates

Templates