Access Care Planning Evo Connector Overview
The Access Care Planning Evo Connector is part of the Access Evo platform. It lets Evo Researcher, Evo Assistants, Evo Workflow Automation and other connected tools read and write data in Access Care Planning (ACP).
The connector has 176 operations across 30 areas. This page lists every one of them, grouped by area, so you can see exactly what is possible before you build something.
How to read this page
Each area has a table with three columns:
Operation - what you can do, in plain English
Tool name - the name of the operation in the connector. Use this when you build a workflow or talk to your technical team.
Type - Read, Create, Update, Replace or Delete
What the types mean:
Read - gets records back. Nothing changes in ACP.
Create - adds a new record.
Update - changes selected fields on an existing record. Fields you leave out stay as they are.
Replace - overwrites a whole record with the data you send.
Delete - removes a record. Only shifts and workplans can be deleted through the connector.
How queries work
Most list operations accept the same set of options:
Filters - narrow results by field values. For example, active records only, a named customer, a branch, a status or a date range.
Sorting - order by a field, ascending or descending. For example, most recently updated first.
Paging - choose where to start and how many records to return.
Field selection - on some operations, return only the fields you need.
A few rules apply across the connector:
Results use your organisation's own terms. If you call customers "service users" or branches "locations", the connector understands those words and returns your labels.
Deleted visits and activities are left out of results.
You only see data your Evo user has permission to see in ACP.
"My branch" questions return the branches linked to the signed-in user.
At a glance
Area | Read | Create | Update | Replace | Delete |
Activities | Yes | Yes | Yes | Yes | - |
Activity definitions | Yes | Yes | - | - | - |
Activity codes | Yes | - | - | - | - |
Alerts | Yes | Yes | Yes | - | - |
Automation rules | Yes | - | - | - | - |
Branches | Yes | Yes | Yes | Yes | - |
Cases | Yes | Yes | Yes | Yes | - |
Case folders and documents | Yes | Yes | - | - | - |
Comments | Yes | Yes | - | - | - |
Customers | Yes | Yes | Yes | Yes | - |
Dashboard | Yes | - | Yes | - | - |
Devices | Yes | Yes | Yes | Yes | - |
Forms | Yes | Yes | Yes | Yes | - |
Submitted forms | Yes | Yes | Yes | Yes | - |
Handovers | Yes | Yes | Yes | - | - |
Medicines | Yes | Yes | Yes | Yes | - |
Medication levels | Yes | Yes | Yes | - | - |
News | Yes | - | - | - | - |
Reports | Yes | Yes | - | - | - |
Services | Yes | - | Yes | - | - |
Shifts | Yes | Yes | Yes | Yes | Yes |
Task types | Yes | Yes | Yes | Yes | - |
Tenant preferences | Yes | - | - | - | - |
Users | Yes | Yes | Yes | - | - |
User groups | Yes | Yes | Yes | - | - |
Visits | Yes | Yes | Yes | - | - |
Workplans | Yes | Yes | Yes | Yes | Yes |
Mobile sync | Yes | - | - | - | - |
Account and subscriptions | Yes | - | - | - | - |
Platform tools | Yes | - | - | - | - |
Activities
Care activities recorded against a customer, such as medication, fluids, vitals, weight, blood sugar, admin tasks and other care tasks.
Activities can be filtered by type, status (Outstanding, Completed, Not Complete, Cancelled), customer, branch, assignee, and planned, due or completed date. That covers questions like missed medication in the last 7 days, or outstanding admin tasks due today.
Operation | Tool name | Type |
List activities with filters for type, status, customer, branch, assignee and dates | getActivities_1 | Read |
List activities | getActivities | Read |
List activities (lightweight version, fewer fields) | getActivitiesLite | Read |
Get a single activity | getActivityById | Read |
Get a count of activities | getActivityCount | Read |
Get activity completion ratios | getActivitiesRatio | Read |
Get the users who close activities | getActivityClosers | Read |
Create an activity | createActivity | Create |
Update selected fields on an activity | updateActivity | Update |
Replace an activity record | replaceActivity | Replace |
Post to an activity | postToActivity | Update |
Update an eMAR (Electronic Medication Administration Record) activity | updateEmarActivity | Update |
To add a comment to an activity, see Comments.
Activity definitions
The templates that generate a customer's recurring activities, and their links to workplans.
Operation | Tool name | Type |
List activity definitions | getActivityDefinitions | Read |
Create an activity definition | createActivityDefinition | Create |
Get a customer's activity definitions | getCustomerActivityDefinitions | Read |
Get a customer's activity definitions (lightweight version) | getCustomerActivityDefinitionsLite | Read |
Create an activity definition for a customer | createCustomerActivityDefinition | Create |
Create an activity definition and link it to a customer's workplan in one step | createCustomerWorkplanActivityDefinition | Create |
Get the links between workplans and activity definitions | getWorkplanActivityDefinitionLinks | Read |
Activity codes
Operation | Tool name | Type |
List activity codes | getActivityCodes | Read |
Get a single activity code | getActivityCodeById | Read |
Alerts
Operation | Tool name | Type |
List all alerts | getAlerts | Read |
Get a single alert | getAlertById | Read |
Create an alert | createAlert | Create |
Update an alert | updateAlert | Update |
Automation rules
See which automation rules have run against a case.
Operation | Tool name | Type |
List automation rule instances for a case | getAutomationRuleInstances | Read |
Get a single automation rule instance | getAutomationRuleInstanceById | Read |
Branches
Branches can be filtered by name, ID, your own branch reference, active status and dates. A "my branches" option returns the branches linked to the signed-in user.
Operation | Tool name | Type |
List branches | getBranches | Read |
Get a single branch | getBranchById | Read |
Create a branch | createBranch | Create |
Update selected fields on a branch | updateBranch | Update |
Replace a branch record | replaceBranch | Replace |
Cases
A case holds a customer's care plan, sections, fields, documents and submitted forms for a care episode or ongoing support.
Cases can be filtered by customer, status, case manager, case nurse, branch, service, archived status and dates.
Operation | Tool name | Type |
List cases | getCases | Read |
Get a single case | getCaseById | Read |
Create a case | createCase | Create |
Update selected fields on a case | updateCase | Update |
Replace a case record | replaceCase | Replace |
Update the value of a single component (field) on a case | updateCaseComponent | Update |
Get the fields on a case | getCaseFields | Read |
Get the sections in a case | getCaseSections | Read |
Get the sections in a case (lightweight version) | getCaseSectionsLite | Read |
Get the forms in a case section | getCaseSectionForms | Read |
Get the submitted forms for a case | getCaseSubmittedForms | Read |
Get the submitted forms for a case (lightweight version) | getCaseSubmittedFormsLite | Read |
Get the answers (elements) in a case's submitted forms | getCaseSubmittedFormElements | Read |
Export a case as a PDF | exportCasePdf | Read |
Case folders and documents
Operation | Tool name | Type |
Create a folder in a case | createCaseFolder | Create |
Get folder details | getCaseFolder | Read |
List what is inside a folder | getCaseFolderChildren | Read |
List the documents in a folder | listCaseDocuments | Read |
Upload a document to a folder | uploadCaseDocument | Create |
Download a document's content | downloadCaseDocument | Read |
Comments
Operation | Tool name | Type |
List comments | getComments | Read |
Get a single comment | getCommentById | Read |
Create a comment | createComment | Create |
Add a comment to an activity | addCommentToActivity | Create |
Customers
People receiving care. Customers can be filtered by name, ID, your own customer reference, role, branch, active status, web access and dates.
Operation | Tool name | Type |
List customers | getCustomers | Read |
Search customers | searchCustomers | Read |
Get a live view of customers | getCustomersLiveView | Read |
Create a customer | createCustomer | Create |
Update selected fields on a customer | updateCustomer | Update |
Replace a customer record | replaceCustomer | Replace |
Get a customer's eMAR data | getCustomerEmar | Read |
Customer activity definitions are listed under Activity definitions. Customer workplans are listed under Workplans.
Dashboard
Operation | Tool name | Type |
Get the dashboard configuration | getDashboardConfig | Read |
Update the dashboard configuration | updateDashboardConfig | Update |
Get key dates (dashboard event views) | getDashboardEventViews | Read |
Devices
Phones and tablets used by carers. Devices can be filtered by operating system, model, branch, active status, shared status and dates.
Operation | Tool name | Type |
List devices | getDevices | Read |
Get a single device | getDeviceById | Read |
Register a new device | registerDevice | Create |
Update selected fields on a device | updateDevice | Update |
Replace a device record | replaceDevice | Replace |
Get the users linked to a device | getDeviceUsers | Read |
Get a device overview | getDeviceOverview | Read |
Forms
Form templates, such as care plans, assessments and checklists. For completed forms, see Submitted forms.
Forms can be filtered by name, folder, version, active, required and read-only status, and dates.
Operation | Tool name | Type |
List forms | getForms | Read |
List forms (lightweight version) | getFormsLite | Read |
Get a single form | getFormById | Read |
Create a form | createForm | Create |
Update selected fields on a form | updateForm | Update |
Replace a form | replaceForm | Replace |
List a form's versions | getFormVersions | Read |
Get a single form version | getFormVersion | Read |
Get the content of a form version | getFormVersionContent | Read |
List the components (fields) used on forms, such as date, text or dropdown fields | getComponents | Read |
Submitted forms
Forms that staff have completed. You can read the full submission, its individual answers and its metadata.
Operation | Tool name | Type |
Get a single submitted form | getSubmittedFormById | Read |
Get the answers (elements) in a submitted form | getSubmittedFormElements | Read |
Get a submitted form's metadata | getSubmittedFormMetadata | Read |
Get submitted forms grouped by form | getFormsSubmitted | Read |
Get a count of submitted forms | getSubmittedFormCount | Read |
Get a count of submitted form updates | getSubmittedFormsUpdatesCount | Read |
Get the users who submit forms | getFormSubmitters | Read |
Create a submitted form | createSubmittedForm | Create |
Update selected fields on a submitted form | updateSubmittedForm | Update |
Replace a submitted form | replaceSubmittedForm | Replace |
Submitted forms for a single visit or case are also available under Visits (getVisitSubmittedForms) and Cases (getCaseSubmittedForms).
Handovers
Operation | Tool name | Type |
List handovers | getHandovers | Read |
Get a single handover | getHandoverById | Read |
Create a handover | createHandover | Create |
Update a handover | updateHandover | Update |
Get a handover overview | getHandoverOverview | Read |
Medicines
Operation | Tool name | Type |
List medicines | getMedicines | Read |
Get a single medicine | getMedicineById | Read |
Create a medicine record | createMedicine | Create |
Update selected fields on a medicine | updateMedicine | Update |
Replace a medicine record | replaceMedicine | Replace |
Medication levels
Operation | Tool name | Type |
List medication levels | getMedicationLevels | Read |
Get a single medication level | getMedicationLevelById | Read |
Create a medication level | createMedicationLevel | Create |
Update a medication level | updateMedicationLevel | Update |
News
Operation | Tool name | Type |
List news items (lightweight version) | getNewsLite | Read |
Reports
Operation | Tool name | Type |
List reports | getReports | Read |
Get a single report | getReportById | Read |
Create a report | createReport | Create |
Run a report and return the results | executeReport | Read |
Services
Operation | Tool name | Type |
List services | getServices | Read |
Get a single service | getServiceById | Read |
Get the sections in a service | getServiceSections | Read |
Get the forms linked to a service section | getServiceSectionFormRels | Read |
Get the static sections in a service | getServiceStaticSections | Read |
Get a single static section in a service | getServiceStaticSection | Read |
Get service preferences | getServicePreferences | Read |
Update a service preference | updateServicePreference | Update |
Shifts
Operation | Tool name | Type |
List shifts | getShifts | Read |
Get a single shift | getShiftById | Read |
Create a shift | createShift | Create |
Update selected fields on a shift | updateShift | Update |
Replace a shift | replaceShift | Replace |
Delete a shift | deleteShift | Delete |
Get a shift overview | getShiftOverview | Read |
Task types
Categories used to group and report on work, such as Medication, Personal Care or Documentation.
Operation | Tool name | Type |
List task types | getTaskTypes | Read |
Get a single task type | getTaskTypeById | Read |
Create a task type | createTaskType | Create |
Update selected fields on a task type | updateTaskType | Update |
Replace a task type | replaceTaskType | Replace |
Get the forms linked to a task type | getTaskTypeForms | Read |
Tenant preferences
Your organisation's own names for ACP terms. For example, "Customer" renamed to "Service User", or "Branch" renamed to "Location". The connector uses these so results match the words your teams use.
Operation | Tool name | Type |
Get your organisation's terminology settings | getTenantPreferences | Read |
Users
Staff with an ACP account, including carers, administrators and supervisors. Users can be filtered by name, role, team, branch, active status and web access.
Operation | Tool name | Type |
List users | getUsers | Read |
Get a single user | getUserById | Read |
Get a single user (lightweight version) | getUserLite | Read |
Get the signed-in user | getCurrentUser | Read |
Create a user with a role | createUserWithRole | Create |
Update selected fields on a user | updateUser | Update |
Get the groups a user belongs to | getUserGroups_1 | Read |
Get the devices linked to a user | getUserDevices | Read |
User groups
Operation | Tool name | Type |
List user groups | getUserGroups | Read |
Create a user group | createUserGroup | Create |
Add a user to a group | addUserToGroup | Update |
Remove a user from a group | removeUserFromGroup | Update |
Visits
Scheduled visits to customers. Visits can be filtered by customer, assignee, branch, status (Outstanding, In Progress, Completed, Cancelled), date range and the text of visit notes. That covers questions like visits today, next week's visits for a carer, or visit notes that mention falls.
Operation | Tool name | Type |
List visits with filters for customer, assignee, branch, status, dates and notes | getVisits | Read |
List visits (lightweight version) | getVisitsLite | Read |
Get a single visit | getVisitById | Read |
Get a live view of visits | getVisitsLiveView | Read |
Create a visit | createVisit | Create |
Update selected fields on a visit | updateVisit | Update |
Get the activities in a visit | getVisitActivities | Read |
Get the activities in a visit (lightweight version) | getVisitActivitiesLite | Read |
Get the submitted forms for a visit | getVisitSubmittedForms | Read |
Get the people who contributed to a visit | getVisitContributors | Read |
Get users with visits not yet synced from their device | getUnsyncedVisits | Read |
Workplans
Operation | Tool name | Type |
Get a customer's workplans | getWorkplans | Read |
Get a single workplan | getWorkplanById | Read |
Create a workplan for a customer | createWorkplan | Create |
Update selected fields on a workplan | updateWorkplan | Update |
Replace a workplan | replaceWorkplan | Replace |
Delete a workplan | deleteWorkplan | Delete |
Mobile sync
Bulk reads built for keeping a device or another system up to date. Most accept an "updated after" date so you only pull what has changed.
Operation | Tool name | Type |
Get activities changed since a date, filtered by customer or planned date | getMobileSyncActivities | Read |
Get cases by case reference, changed within a date range | getMobileSyncCases | Read |
Get news views by date, with a limit per customer | getMobileSyncNews | Read |
Get tasks changed since a date | getMobileSyncTasks | Read |
Get visits changed since a date | getMobileSyncVisits | Read |
Get workplans changed since a date, filtered by customer | getMobileSyncWorkplans | Read |
Account and subscriptions
Operation | Tool name | Type |
List the ACP subscriptions linked to the signed-in Access Identity user | getApplicationSubscriptions | Read |
Get a single ACP subscription linked to the signed-in user | getApplicationSubscriptionById | Read |
Platform tools
Operation | Tool name | Type |
Send a list of record types with timestamps and see which have changed since | checkForUpdates | Read |
Get paged records with filters, sorting and field selection | getAll | Read |
Get a single icon | getIconById | Read |
Get a summary of what the connector can help with | getDefaultPrompt | Read |
Get the connector's manifest | getPluginManifest | Read |
FAQs
Can the connector read form submissions? Yes. You can read a single submission, its individual answers and its metadata. You can also pull every submitted form for a visit or a case, see counts, and see who submitted them. See Submitted forms.
Can it read medication records? Yes. You can read and update eMAR activities, read a customer's eMAR data, and manage medicines and medication levels.
Can it delete records? Only shifts and workplans. Everything else can be updated or replaced, but not deleted, through the connector.
Can it read visit notes? Yes. Visits can be filtered by the text in their notes, for example notes that mention falls, refusals or escalations.
Need help?
If you need help connecting to ACP, contact your Access account manager or raise a case with our support team.