For the complete documentation index, see llms.txt. This page is also available as Markdown.

Programs

Read program definitions and manage patient program enrollment.

Programs represent structured care pathways in Welkin — defining phases, tasks, and workflows that guide a patient's care journey.

Base path: /{tenantName}/{instanceName}/programs


Endpoints

GET Get All Programs

GET /{tenantName}/{instanceName}/programs

Returns all program definitions configured in the instance.

Query Parameters

Parameter
Type
Default
Description

page

integer

0

Page number

size

integer

20

Results per page

Example Response 200 OK

{
  "data": [
    {
      "name": "diabetes-management",
      "label": "Diabetes Management Program",
      "phases": [
        { "name": "onboarding", "label": "Onboarding", "order": 1 },
        { "name": "active-monitoring", "label": "Active Monitoring", "order": 2 },
        { "name": "maintenance", "label": "Maintenance", "order": 3 }
      ]
    }
  ]
}

GET Get Program by Name

GET /{tenantName}/{instanceName}/programs/{programName}

Returns a single program definition with all phases and configuration.

Path Parameters

Parameter
Type
Required
Description

programName

string

Yes

Program name as configured in Designer


To enroll patients in programs or manage their enrollment status, see Patient Programs.

Last updated

Was this helpful?