Welkin Naming Conventions Dictionary

Overview

Consistent naming is critical in Welkin. Names given to programs, phases, assessments, CDTs, CDTFs, automations, and other objects are used across the platform – in automations, API calls, data exports, widget conditions, and reporting. Poorly chosen names create confusion and make maintenance difficult.

This page provides naming conventions and a reference dictionary for Welkin platform objects.

---

General Naming Principles

• Be descriptive – names should immediately convey what the object does or contains

• Be consistent – use the same naming pattern across similar objects

• Avoid abbreviations unless they are universally understood within your organization

• Use Title Case for display names (e.g., "Initial Assessment", "Behavioral Health Program")

• Use snake_case or camelCase for API field names and CDT field identifiers

• Avoid special characters in technical identifiers (underscores are acceptable)

---

Object Naming Reference

Object	Recommendation	Example
Program	Descriptive care pathway name	"Diabetes Care Program"
Phase	Stage name within the program	"Active Monitoring", "Discharged"
CDT	Data category being captured	"Vitals", "Medication List"
CDTF (field)	The specific data point	"blood_pressure_systolic"
Assessment	Purpose + "Assessment" or "Form"	"PHQ-9 Assessment", "Consent Form"
Automation	Trigger + action description	"On Assessment Submit – Create Task"
Webhook	Target system + event	"EHR Sync – Patient Update"
Role	Job function	"Care Manager", "Clinician", "Supervisor"

---

Reserved and System Terms

The following are Welkin system terms – avoid using them as custom object names to prevent confusion:

• Patient, Contact, Encounter, Program, Phase, Assessment, CDT, CDTF, Automation, Webhook, Role, Policy, Region, Territory

If your organization renames these terms using Brand Terminology Flexibility (see Brand Terminology Flexibility), document the mapping clearly.

---

API Field Naming

When naming CDT fields, the API identifier is derived from the display name. Use lowercase with underscores for field names:

• blood_pressure not BloodPressure or BP

• date_of_last_visit not last visit date

---

Change Control

Renaming objects after go-live should be done with caution. Automations, API integrations, and report queries that reference object names by string will break if names change. Always test after renaming in a sandbox environment first.

---

Key Welkin Terms

Core Entities

• Patient – individual receiving care; identified by unique ID, demographics, and contacts

• Encounter – documented patient interaction (visit, call, telehealth session); contains clinical notes and assessments

• Assessment – structured data collection form; can be self-administered or clinician-completed

• Program – defined care pathway (e.g., Diabetes, Behavioral Health); contains phases

• Phase – stage within a program (e.g., Intake, Active, Discharged); patient progresses through phases

Data & Configuration

• CDT (Custom Data Type) – structured data category for storing repeatable information (vitals, meds, labs)

• CDTF (CDT Field) – individual data point within a CDT (e.g., systolic within Vitals)

• Role – user permission level defining access to portals and data

• Automation – rule-based workflow triggered by events, schedules, or conditions

Related Topics

• Brand Terminology Flexibility – renaming platform terms

• Programs and Phases – program configuration

• Custom Data Types – CDT overview

• How to Create Automations – automation setup