Client groups
Client groups let you bundle clients that belong together — for example, the participants of a group treatment or a fixed client population. A group has a name, an optional description and a list of members. Each membership has a start date and an optional end date, so you can record when a client is part of the group.
The overview screen lists all groups in your organization; from the detail screen you manage the details and the members of a single group.
Overview
| Route | /client-groups (overview), /client-groups/:groupId (detail) |
| Audience | Practitioner |
| Required permissions | client_groups.read (view); client_groups.create, client_groups.update, client_groups.delete and client_groups.manage_members for specific actions |
For each group the overview shows the name, the description and the number of members. Click a row to open the group's detail screen.
Create group
Click New group at the top right to create a new client group. A dialog opens with the group details.
| Field | Required | Description |
|---|---|---|
| Name | Yes | The name of the group. |
| Description | No | A short explanation of the group. |
Click Create group to save the group. The New group button is only visible with the client_groups.create permission.
Search
Use the search bar above the list to quickly find a group. The query filters on name and description. The list updates automatically as you type; press Enter to search immediately.
| Field | Required | Description |
|---|---|---|
| Search term | No | Part of a group name or description. |
Sort
Click the Name column header to sort the groups by name. Click again to reverse the sort order (ascending or descending). By default the groups are sorted ascending by name.
Paginate
When there are more groups than fit on a single page, pagination appears at the bottom. Use Previous and Next to page through the list; the current page and the total number of pages are shown in between. By default 20 groups are shown per page.
Edit name and description
Open a group and click Edit to change the name or description. The detail screen switches to edit mode.
| Field | Required | Description |
|---|---|---|
| Name | Yes | Up to 100 characters. |
| Description | No | Up to 500 characters. |
Click Save to keep the changes, or Cancel to return without saving. Editing requires the client_groups.update permission.
Delete group
At the bottom of the detail screen is the Delete section. Click Delete group and confirm in the dialog to permanently delete the group. The clients themselves are not deleted — only the group and its memberships are removed. Deleting requires the client_groups.delete permission.
Add member
In the Members section on the detail screen, click Add member to add a client to the group. A dialog opens where you search for the client and record the membership period.
| Field | Required | Description |
|---|---|---|
| Client | Yes | Search for and select the client (at least 2 characters). |
| Start date | Yes | The date on which the membership starts. |
| End date | No | The date on which the membership ends. |
Clients that are already members cannot be added again. Adding, editing and removing members requires the client_groups.manage_members permission.
Edit membership
Click the edit icon (Edit membership) on a member to change the membership period. A dialog opens with the member's start date and end date.
| Field | Required | Description |
|---|---|---|
| Start date | Yes | The date on which the membership starts. |
| End date | No | The date on which the membership ends. |
Click Save to keep the changes. This action requires the client_groups.manage_members permission.
Remove member
Click the remove icon (Remove member) on a member and confirm in the dialog to take the client out of the group. The client itself remains; only the membership is removed. This action requires the client_groups.manage_members permission.