Custom Fields
Custom fields let you add organization-specific data fields to patients, tasks, and instances. Once configured, they appear inline wherever that resource is viewed or edited.
Navigating to Custom Fields
Go to Settings > Custom Fields. The page has three tabs:
- Patients — fields that appear on patient records
- Tasks — fields that appear on tasks (not subtasks)
- Instances — fields that appear on instance records
Each tab manages its own set of fields independently.
Adding a Field
- Select the tab for the resource you want to add a field to (Patients, Tasks, or Instances).
- Click the + button in the top-right of the table to add a new row.
- Fill in the required columns for the new field:
- Display — the label shown to users (e.g.,
Intake Visit Date) - Code — a unique internal identifier using lowercase letters, numbers, and hyphens (e.g.,
intake-visit-date). Each code must be unique within the tab. - Type — the data type for the field. See Field Types below.
- Options — only shown for Dropdown fields. Enter a comma-separated list of options (e.g.,
Active,Inactive,Pending). - Searchable — check this box if you want the field to be searchable.
- Display — the label shown to users (e.g.,
- Click Save in the top-right corner to apply your changes.
Field Types
| Type | Description |
|---|---|
| String | Free-text input |
| Dropdown | Select from a predefined list of options |
| Boolean | True/false checkbox |
| Integer | Whole number |
| Decimal | Number with decimal places |
| Date | Date picker |
| DateTime | Date and time picker |
Removing a Field
Click the − button on the right side of the row you want to remove, then click Save.
Removing a custom field will delete it from the configuration. Any data already entered for that field on existing records will no longer be visible.
Task Custom Fields and Task Types
Task custom fields support an additional Task Types column. This lets you restrict a field so it only appears on tasks of a specific type, rather than on every task.
Prerequisites
The Task Types column only appears when your workspace has at least one task type configured. To set up task types, go to Settings > Task Types. See Managing Task Types.
Assigning a Field to Specific Task Types
- Go to Settings > Custom Fields and select the Tasks tab.
- Find the field you want to restrict in the table.
- Click the Task Types selector for that field and choose one or more task types from the list.
- Leave it blank ("All task types") to show the field on every task regardless of type.
- Select one or more types to show the field only when a task matches one of those types.
- Click Save.
When a task's type is changed, the visible custom fields update automatically to match.
Custom Fields and Subtasks
Custom fields are never shown on subtasks, regardless of task type settings. They appear only on parent tasks.
Tips
- Codes must be unique within each tab. The Save button will be disabled if any two fields share the same code.
- Use clear, consistent codes — they are used internally and cannot be changed without re-creating the field.
- Plan your field types carefully. Changing a field's type later requires removing and re-adding it.