Utility Calls

Utility Calls

Purpose

The Utility Calls API handles internal calls that are useful for managing settings. These settings include the roles that users have, integration data, cache handling, and code information.

Endpoint List

• v2/caches
• v2/clinicians/rolefunctions/{id}
• v2/clinicians/roles
• v2/clinicians/roles/{id}
• v2/clinicians/roles/{id}/staff
• v2/clinicians/roles/{roleId}/all-functions
• v2/clinicians/roles/{roleId}/available-functions
• v2/clinicians/roles/{roleId}/functions
• v2/clinicians/roles/{roleId}/functions/{functionId}
• v2/clinicians/roles/{roleId}/on-off
• v2/clinicians/roles/{roleId}/staffprofiles
• v2/clinicians/roles/functions
• v2/clinicians/roles/infos
• v2/clinicians/roles/names/{roleName}
• v2/codesets
• v2/CptCodes
• v2/helpcenter/admin/url
• v2/helpcenter/customer/url
• v2/helpcenter/physician/url
• v2/meetings/{meetingId}/participants
• v2/people
• v2/people/{personId}/telecoms
• v2/people/{personId}/telecoms/{telecomId}
• v2/smstemplates
• v2/smstemplates/hospitals/{id}
• v2/smstemplates/{smsTemplateId}
• v2.1/log-messages
• v2.1/patients/registrations/availability
• v2.1/people
• v2.1/users/current-time

Recipes

Any endpoints that handle administrative functions are listed under the "Administrative Functions" page.

Getting Help Center URLs

The help center URLs for ZenDesk which a user would need depend on their user type.
Administrators: v2/helpcenter/admin/url
Hospital Clients: v2/helpcenter/customer/url
Physicians: v2/helpcenter/physician/url

Meetings

Use GET v2/meetings/{meetingId}/participants to get a list of participants in a meeting.

People

Patients, physicians, and other users are handled in the system as "people," which encapsulates all of their common attributes.

1. Use GET v2.1/people to get a person by their email address.
2. Use POST v2/people to create a person in the system.
3. Use GET or POST v2/people/{personId}/telecoms to get existing or add new telecoms connected to a person.
4. Use DELETE v2/people/{personId}/telecoms/{telecomId} to delete a telecom connected to a person.

Roles

To manipulate roles, a user must have the necessary permissions to add or edit roles and their functions. Use GET on the following endpoints to ensure that users have the proper permissions for role editing.

1. v2/clinicians/rolefunctions/{id}: Whether a user has permission to add or edit roles

Use the following endpoints to manipulate roles. These endpoints do not involve assignment to users or modification of users' permissions, but rather general information that the system uses when evaluating roles themselves.

1. Use GET or POST v2/clinicians/roles to access roles in the system or add new roles.
2. Use DELETE v2/clinicians/roles/{id} to delete a role from the system.
3. Use GET v2/clinicians/roles/infos to get all information about a role.
4. Use GET v2/clinicians/roles/names/{roleName} to make sure a role name is valid.

Use the following endpoints to manipulate functions which are associated with roles:

1. Use POST or DELETE v2/clinicians/roles/{roleId}/all-functions to add all available role functions to, or remove all available role functions from, a particular role.
2. Use GET v2/clinicians/roles/{roleId}/available-functions to access available functions that can be assigned to a role.
3. Use GET or POST v2/clinicians/roles/{roleId}/functions to get whether a function is assigned to a role, or add a function to a role.
4. Use DELETE v2/clinicians/roles/{roleId}/functions/{functionId} to delete a function from a role.
5. Use GET v2/clinicians/roles/functions to get all available role functions.

Use the following endpoints to associate roles with staff members:

1. Use POST or DELETE v2/clinicians/roles/{id}/staff to assign a role to, or delete a role from, a staff member.
2. Use GET v2/clinicians/roles/{roleId}/staffprofiles to get all staff profiles which have a particular role.
3. Use PUT v2/clinicians/roles/{roleId}/on-off to activate or deactivate a role a staff member has, without removing the role from their profile.

SMS Templates

Use the following endpoints to handle SMS messaging.

1. Use POST v2/smstemplates to create a new SMS template.
2. Use GET or PUT v2/smstemplates/hospitals/{id} to access or edit a SMS template associated with a hospital
3. Use DELETE v2/smstemplates/{smsTemplateId} to delete a SMS template.

System Support

The following endpoints are used to help support the system in running well.

1. Use DELETE v2/caches to delete memory caches.
2. Use GET v2/codesets to get code sets.
3. Use GET v2/CptCodes to get CPT codes.
4. Use POST v2.1/log-messages to store system log messages.
5. Use GET v2.1/patients/registrations/availability to get whether a patient can be registered in the system.
6. Use GET v2.1/users/current-time to get the current time in the user's time zone.
7. Use GET v2/timezones to get a list of time zones used by system participants.