Account
| API | Description |
|---|---|
| POST api/account/clientportallogin |
Authenticates client portal user credentials Consumers: Client Portal |
| POST api/account/clientportalemployeelogin |
Authenticates client portal employee user credentials Consumers: Client Portal |
| POST api/account/mobilelogin?appVersion={appVersion} |
Authenticates mobile app user credentials. The password is expected to be hashed using MD5 algorith. |
Admin
Business operations related to administrative tasks.
| API | Description |
|---|---|
| GET api/admin/{visitTypeId}/GetVisitType |
Gets a specific visit type. |
| GET api/admin/GetVisitType |
Gets a list of all visit types. |
| GET api/admin/GetFormGroup |
Gets a list of form groups |
| GET api/admin/GetMedsStatus |
Gets a list of med statuses. |
| GET api/admin/GetEmployeeConfig |
Gets the list of employee configurations. |
| GET api/admin/GetPartnerConfig |
Gets the list of partner configurations. |
| POST api/admin/GetPartnerConfig |
Gets the list of partner configurations requested. |
| POST api/admin/partnerconfig/getbynamelist |
Gets the list of partner configurations requested. |
| GET api/admin/GetSecurityMatrix |
Gets the list of Security Matrix configurations for the current employee. |
| POST api/admin/securitymatrix/getbyactionlist |
Gets the list of Security Matrix configurations for the current employee. |
| GET api/admin/GetChangeLogTypes |
Gets the list of existing change log types. |
| POST api/admin/AddHipaaLogEntry |
Adds an entry to HIPAA log |
| GET api/admin/txplancategories?status={status} |
Gets a list of TXCategories filtered by status. |
| GET api/admin/diagnosis/diseaseclassifications?getDsm5={getDsm5}&getIcd9={getIcd9} |
Gets a list of diagnoses by classification system. |
| GET api/admin/lookupdictionary?from={from}&count={count} |
Gets a list of look up dictionary records. |
| GET api/admin/visitstatuses?from={from}&count={count} |
Gets a list of visit statuses. |
| POST api/admin/push-notifications/device-registration |
Registers a mobile device to the push notifications service. |
| GET api/admin/file-upload-api/startupdata |
Gets the upload data needed to reach and call UploadFile API action that uploads files. |
AdminTime
Business operations related to admin times.
| API | Description |
|---|---|
| GET api/admintime/types?employeeId={employeeId} |
Returns the list of admin time types available to user |
| POST api/admintime/search |
Retuns list of admin time records matching given search criteria |
| POST api/AdminTime |
Adds a new admin time record for the user. |
| PUT api/AdminTime |
Updates given admin time record |
| DELETE api/AdminTime?adminTimeId={adminTimeId} |
Deletes given admin time record |
| POST api/{version}/AdminTime |
Adds a new admin time record for the user. |
| PUT api/{version}/AdminTime |
Updates given admin time record |
| DELETE api/{version}/AdminTime?adminTimeId={adminTimeId} |
Deletes given admin time record |
CareClients
| API | Description |
|---|---|
| GET api/care/clients?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count}&useEmployeePermissions={useEmployeePermissions}&firstName={firstName}&lastName={lastName} |
Gets a list of ACTIVE clients, associated to the employee who sent the request, and that match the search filters and parameters (provided in the query string). |
| GET api/care/clients/{clientId}/credible-plan/get |
No documentation available. |
CareCrediblePlan
API controller type that handle credible plan related requests for care apps.
CareGps
| API | Description |
|---|---|
| POST api/care/gps/log-event |
No documentation available. |
| GET api/care/gps/search-place-for-position?latitude={latitude}&longitude={longitude} |
No documentation available. |
| GET api/care/gps/search-place-for-positions?latitude={latitude}&longitude={longitude}&numberOfResults={numberOfResults} |
No documentation available. |
CareLogin
| API | Description |
|---|---|
| POST api/care/login |
No documentation available. |
| GET api/care/login/IsSsoEnabled?domainName={domainName} |
No documentation available. |
| GET api/care/login/IsSsoEnabled |
No documentation available. |
| GET api/care/login/SsoAuthentication?domainName={domainName} |
Validates SSO authentication of the indicated user (in authorization header) for the indicated domain |
CareStartUp
| API | Description |
|---|---|
| POST api/care/startup/get-startup-data?page={page}&perPage={perPage} |
No documentation available. |
CareVisits
| API | Description |
|---|---|
| POST api/care/visits/temp/{tempVisitId}/credible-plan/documentation |
No documentation available. |
| GET api/care/visits/{clientVisitId}/pdf |
No documentation available. |
| POST api/care/visits/pdf-list |
No documentation available. |
| POST api/care/visits/evv/transaction |
No documentation available. |
| POST api/care/visits/evv/transactions |
No documentation available. |
ClientPortal
End point for client portal web API.
| API | Description |
|---|---|
| GET api/clientportal/MyMedications?myClientId={myClientId}&state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets the list of medications of the client doing the request. |
Clients
Exposes business operations related to clients.
| API | Description |
|---|---|
| GET api/clients?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count}&useEmployeePermissions={useEmployeePermissions}&firstName={firstName}&lastName={lastName} |
Gets a list of ACTIVE clients, associated to the employee who sent the request, and that match the search filters and parameters (provided in the query string). |
| GET api/clients/{clientId}/profiles |
Gets the profile data of the provided client. Consumers: Client Portal |
| POST api/clients/{clientId}/ProfileImage |
Posts and saves the picture provided and associates it to the client. |
| GET api/clients/{clientId}/streamedProfileImage?width={width}&height={height}&preserveAspectRatio={preserveAspectRatio} |
Gets the profile image of the provided client. |
| GET api/clients/{clientId}/profileImage?width={width}&height={height}&preserveAspectRatio={preserveAspectRatio} |
No documentation available. |
| GET api/clients/{clientId}/allergies?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets the list of allergies of a client. |
| GET api/clients/{clientId}/basicAllergies |
Gets the list of allergies of a client, including a friendly description of the severity. Consumers: Client Portal |
| POST api/clients/{clientId}/allergy/add |
Adds an allergy to a client |
| PUT api/clients/{clientId}/allergy/update |
Updates exisiting client allergy information. |
| DELETE api/clients/{clientId}/allergy/{clientAllergyId}/delete |
Deletes an existing client allergy. |
| PUT api/clients/{clientId}/allergy/discontinue |
Discontinues an existing client allergy. |
| GET api/clients/{clientId}/contacts?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets the list of contacts of a client. Consumers: Client Portal |
| GET api/clients/{clientId}/medications?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets the list of medications of a client. Consumers: Client Portal |
| GET api/clients/{clientId}/diagnosis?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets the diagnoses of a client. Consumers: Client Portal |
| POST api/clients/detailList?count={count} |
Gets a list of client details for a set of provided clients. |
| POST api/clients/basicProfileInfo?count={count} |
Gets basic profile information for each client passed in a list of client Ids e.g. first name, last name, dob, gender, etc. Consumers: Client Portal |
| GET api/clients/{clientId}/insurance?active_only={active_only}&allowinsidedit={allowinsidedit}&count={count} |
Gets the list of insurance providers of a client. Consumers: Client Portal |
| GET api/clients/{clientId}/medicalProfile |
Gets the list of medical profiles of a client Consumers: Client Portal |
| GET api/clients/{clientId}/immunizations |
Gets the list of immunizations of a client Consumers: Client Portal |
| GET api/clients/{clientId}/labs |
Gets the list of lab results of a client Consumers: Client Portal |
| GET api/clients/{clientId}/orders |
Gets the list of orders of a client Consumers: Client Portal |
| GET api/clients/profiles/datadictionary-fields/configuration?tableNameList[0]={tableNameList[0]}&tableNameList[1]={tableNameList[1]} |
Gets a DataDictionaryData object; this object contains a list of profile fields configured in the DataDictionary for the given list of table names, and a list of text-value collections to be used as source for the configured DropDown fields. If the table name list parameter is omitted it will return Clients and ClientsExt tables by default. |
| POST api/clients/profiles/datadictionary-fields/program-map/get |
A list of mappings between DataDictionary fields (profile fields configured in the DataDictionary) and the programs where each apply. |
| POST api/clients/profiles/datadictionary-fields/values/get |
Gets the list of Values for each profile fields configured in the DataDictionary. |
| PUT api/clients/{clientId}/no-allergy/update |
Updates the value of the No Allergy flag of a client. |
| POST api/clients/start-up-data/get |
Gets the data needed for client operations. |
| POST api/clients/{clientId}/contacts/add |
Adds a new contact to a client. |
| DELETE api/clients/{clientId}/contacts/{contactId}/delete |
Deletes a contact that belongs to a client. |
| PUT api/clients/{clientId}/contacts/{contactId}/update |
Updates a contact that belongs to a client. |
| GET api/clients/{clientId}/attachments/list |
Gets de list of attachments associated to a client. |
| GET api/clients/{clientId}/attachments?guid={guid} |
Gets an attachment file assoicated to a client. This operation downloads a file through a stream of bytes. The Content-Type, Content-Length and Content-Disposition headers are included as part of the response. |
| DELETE api/clients/{clientId}/attachments?guid={guid} |
Deletes an attachment file associated to a client. |
| POST api/clients/{clientId}/attachments/attach-file |
Associates an uploaded file with an existing client (attach) |
| PUT api/clients/{clientId}/attachments/{fileId}/update |
No documentation available. |
| GET api/clients/{clientId}/families?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets the list of dependents of a client. |
| POST api/clients/{clientId}/family_members/add |
Adds a new family member (dependent) to a client. |
| PUT api/clients/{clientId}/family_members/{dependentId}/update |
Updates a family member (dependent) that belongs to a client. |
| DELETE api/clients/{clientId}/family_members/{dependentId}/delete |
Deletes a family member (dependent) that belongs to a client. |
| GET api/clients/{clientId}/credible-plan/get |
Gets the active credible plans associated to a client. |
EmarClients
| API | Description |
|---|---|
| GET api/emar/clients?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count}&useEmployeePermissions={useEmployeePermissions}&firstName={firstName}&lastName={lastName} |
Gets a list of ACTIVE clients, associated to the employee who sent the request, and that match the search filters and parameters (provided in the query string). |
| GET api/emar/clients/{clientId}/get-profile-image?width={width}&height={height}&preserveAspectRatio={preserveAspectRatio} |
No documentation available. |
| POST api/emar/clients/{clientId}/save-profile-image |
Posts and saves the picture provided and associates it to the client. |
| POST api/emar/clients/{clientId}/get-emar |
Gets the eMAR of a Client |
| POST api/emar/clients/{clientId}/administer-medication |
Records the administration of an eMAR medication to a Client |
EmarLogin
| API | Description |
|---|---|
| POST api/emar/login |
No documentation available. |
EmarStartUp
| API | Description |
|---|---|
| POST api/emar/startup/get-startup-data |
No documentation available. |
Employees
Business operations related to employees
| API | Description |
|---|---|
| POST api/employees/detailList |
Gets the employee details for the ids passed as a parameter. |
| GET api/employees/{employeeId}/profileImage?width={width}&height={height}&preserveAspectRatio={preserveAspectRatio} |
Gets the profile image of the provided employee. |
| POST api/employees/{employeeId}/profileImage |
Posts and saves the picture provided and associates it to the employee. |
| GET api/employees/{employeeId}/activesignature?fromDate={fromDate} |
Gets the active signature of an employee as a base 64 string. |
| POST api/employees/activesignature |
Saves the signature supplied, activates it and associates it to the employee. |
| GET api/employees/messages?fromEmployeeId={fromEmployeeId}&toEmployeeId={toEmployeeId}&status={status}&since={since} |
Retrieves a list of employee messages. |
| POST api/employees/messages/create |
Creates a new employee message. |
| PUT api/employees/messages/markasread |
Marks a set of employee messages as read (the supplied messages must belong to the employee marking them). |
| GET api/employees/withmessaging |
Gets the list of employees with Messaging turned on. |
| POST api/employees/{employeeId}/todo-list/get?getDropDowns={getDropDowns} |
Gets the "To Do List" of a supplied employee. |
| POST api/employees/{employeeId}/todo-list/add-item |
Adds a new item to the "To Do List" of an employee. |
| PUT api/employees/todo-list/{toDoListId}/complete |
Completes or Undoes the completion of a supplied "To Do List" item. |
| DELETE api/employees/todo-list/{toDoListId}/delete |
Deletes a "To Do List" item. |
| PUT api/employees/todo-list/{toDoListId}/update |
Updates and existing "To Do List" item. |
| PUT api/employees/{employeeId}/set-pin |
Updates an employee's pin number. |
| PUT api/employees/{employeeId}/validate-pin |
Validates an employee's pin number. |
Forms
Exposes business operations related to forms and visits.
| API | Description |
|---|---|
| GET api/forms/GetForms?state={state}&sinceDate={sinceDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets all active (version) forms that meet the search parameters. |
| GET api/forms/{formId}/detail |
Gets the details of a form. |
| GET api/forms/{formId}/tree |
Gets the full structure of a form and returns it as a hyerarchical tree structure. |
| GET api/forms/{formId}/fullStructure |
Gets the full structure of a form by its Id. |
| GET api/forms/version/{formVersionId}/fullStructure |
Gets the full structure of a form by its version. |
| POST api/forms/fullStructure |
Gets the full structure of each of the forms provided in the list (If a form has more than one version it gets the structure of the active one). |
| GET api/forms/category/{categoryId}/detail |
Gets the details a form category. |
| GET api/forms/question/{questionId}/detail |
Gets the details of a form question. |
| GET api/forms/answer/{answerId}/detail |
Gets the details of a form question answer. |
| GET api/forms/GetFormsPartnerConfig |
Gets the list of partner configurations related to forms. |
| GET api/forms/client/{clientId}/GetClientInjectedDataHTMLs |
Gets all form injected values in HTML format for a client. |
| GET api/forms/employee/{employeeId}/GetEmployeeInjectedDataHTMLs |
Gets all form injected values in HTML format for an employee. |
| GET api/forms/employee/GetFormGroups |
Get the list of form groups that the user doing the request is able to see. |
| GET api/forms/client/{clientId}/GetListsForSaveAndSubmit?programId={programId} |
No documentation available. |
| GET api/forms/GetListsForSignAndSubmit |
No documentation available. |
| POST api/forms/CreateIncompleteVisit |
Creates one or many incomplete visit depending on the input data. |
| PUT api/forms/SaveAnswers |
No documentation available. |
| PUT api/forms/UpdateIncompleteVisit |
No documentation available. |
| POST api/forms/SaveAndSubmit |
Execute the process for signing and submitting an incomplete visit. |
| GET api/forms/{visitTempId}/GetIncompleteVisit |
Gets an incomplete visit. |
| GET api/forms/{planId}/GetOrCreateIncompleteVisit |
Gets all existing incomplete visits associated to the provided plan, if none are found then it creates them. This opperation supports group visits and form groups; however in the case of group visits, it will only create the visits for the clients in the group that are also assigned to the employee making the request. |
| GET api/forms/{planId}/incomplete-visits/get |
Gets a list of incomplete visits with full data for the given plan id. If there are no records the response will be an empty list. |
| POST api/forms/visits?fromDate={fromDate}&toDate={toDate}&page={page}&perPage={perPage}&sort={sort}&count={count} |
Gets all past visits that match the search parameters. |
| POST api/forms/datainjections/itc |
Gets all the possible ITC injections for a set of clients. |
| POST api/forms/datainjections/idd |
Gets all the possible IDD injections for a set of clients. |
| POST api/forms/visits/discardincompletevisits |
No documentation available. |
GroupVisits
| API | Description |
|---|---|
| POST api/GroupVisits |
No documentation available. |
| POST api/{version}/GroupVisits |
No documentation available. |
HealthCheck
| API | Description |
|---|---|
| GET api/HealthCheck | |
| GET api/{version}/HealthCheck |
Providers
Business operations related external providers and their client assignation
| API | Description |
|---|---|
| GET api/providers/external/{clientId} |
Gets all the external providers assigned for the client doing the request Consumers: Client Portal |
Schedules
Exposes business operations related to schedules.
| API | Description |
|---|---|
| GET api/schedules/getClientGroup |
Gets the list of scheduled groups of the employee doing the request. |
| POST api/schedules/Add |
Adds an item to the schedule. |
| PUT api/schedules/Update |
Updates an item in the schedule. |
| GET api/schedules/{plannerId}/evv-tran/get |
No documentation available. |
| GET api/Schedules?startDate={startDate}&endDate={endDate}&page={page}&perPage={perPage}&sort={sort}&count={count}&clientId={clientId} |
Gets a list of scheduled items, associated to the employee who sent the request, and that match the search filters and parameters (provided in the query string). |
| DELETE api/Schedules?planId={planId} |
Deletes an item in the schedule. |
| GET api/{version}/Schedules?startDate={startDate}&endDate={endDate}&page={page}&perPage={perPage}&sort={sort}&count={count}&clientId={clientId} |
Gets a list of scheduled items, associated to the employee who sent the request, and that match the search filters and parameters (provided in the query string). |
| DELETE api/{version}/Schedules?planId={planId} |
Deletes an item in the schedule. |
Teams
Business operations related to clients and its team assignation
| API | Description |
|---|---|
| GET api/teams/members/{clientId} |
Gets all the employees assigned for the client doing the request |
| GET api/Teams |
Gets all teams that the authenticated employee is allowed to see. |
| GET api/{version}/Teams |
Gets all teams that the authenticated employee is allowed to see. |
TxPlan
Exposes business operations related to TxPlan.
| API | Description |
|---|---|
| GET api/TxPlan?clientId={clientId}&count={count} |
Gets the list of TxPlan of a client. Consumers: Client Portal |
| GET api/{version}/TxPlan?clientId={clientId}&count={count} |
Gets the list of TxPlan of a client. Consumers: Client Portal |
TxPlus
Exposes business operations related to TxPlus.
| API | Description |
|---|---|
| PUT api/txplus/SaveAnswers |
No documentation available. |
| GET api/txplus/{visitTempId}/GetTxPlusAnswers |
Gets the list of TxPlus answers of an incomplete visit. |
| GET api/TxPlus?clientId={clientId}&count={count} |
Gets the list of TxPlus of a client. Consumers: Client Portal |
| GET api/{version}/TxPlus?clientId={clientId}&count={count} |
Gets the list of TxPlus of a client. Consumers: Client Portal |