Integrating Eyefinity APIs with Certified Partners

This section describes how to set up AcuityLogic to use with Eyefinity Patient Engagement certified partners (such as Solutionreach, Demandforce) and Bulk Data API partners (such as EDGEPro GPN Technologies). Once setup, your practice can send engagement campaigns to your patients using the tools provided by Patient Engagement Certified partners or your partner can use the Bulk Data API to capture a "snapshot" of your data for financial reporting and dashboards.

Topics include the following:

Verifying Administrators Are Properly Set Up


Do not create or set up user accounts for certified partners. Instead of creating users for partners, you can grant them access by logging into the partners authentication website and entering your login credentials. See below for more details.

To set up the interface for certified partners, please ensure users who authorize access to your data are administrators.

AcuityLogic creates an audit log each time an administrator gives a certified partner permission to access your data. Additionally, all appointments and engagement tracking information created by the partner is tracked and can be audited through a report.

  1. In AcuityLogic Admin, click Company and select Company Setup.

    The Company Information window opens.

  2. Click the Employees link for your company.

    The Company Employees window opens.

  3. Find and click the link in the Last Name column for the user account that will authorize the certified partner.

    The Employee window opens.

  4. From the Role Name drop-down list, select System Admin, and click Add.

    If you have a legacy API user with only the APIUser role, and a user with System Admin privileges initiates a required password reset, do this:

    1. Log into AcuityLogic POS with the following credentials:

      • User name assigned the APIUser role

      • At the prompt, reset the password.

    2. Set a new password that meets the following requirements:

      • Minimum of 10 characters in length

      • Cannot repeat more than two characters

      • Cannot be identical to the previous 10 passwords used

      • Must contain any three of the following:

        • One uppercase character
        • One lowercase character
        • One number
        • One special character

    After the password is reset, the user name specified in Step a cannot log into the AcuityLogic user interface.


    If the AcuityLogic API server loses connection with Eyefinity for 30 minutes or more, the API token expires and the API user’s password must be reset. (This may occur during extended network outages, ISP changes, server replacements, and so on.)
    After resetting the API User password, follow the steps for Enabling Access to the Patient Engagement Interface below.
  5. Click Save.
  6. To close the Company Employees window, click Return.
  7. Go to AcuityLogic BackOffice and verify you can log in using the account.

For more information, see Setting Up Employees.

Enabling Access to the Patient Engagement Interface

After administrators are set up to facilitate data transfer from AcuityLogic to Patient Engagement certified partners, they can give partners access to the Patient Engagement Interface. When a partner gets access, a user account with restricted access is automatically created for the partner.

  1. Go to the portal provided to you by the Patient Engagement certified partner. A Sign On window opens.

  2. Log into the portal by using the AcuityLogic account user name and password (as verified in Verifying Administrators Are Properly Set Up).


    When you log into the portal, you must append _pm_CompanyID_pm to your user name. For example, if your user name is jsmith and your company ID is 12345, enter the user name jsmith_pm_12345_pm. If you don't know your company ID, contact Eyefinity Customer Care.
  3. Select the information you want the Patient Engagement certified partner to access, and click Allow.

Disabling Access to the Patient Engagement Interface

To disable access to the Patient Engagement Interface, use one of these options:

  • Call Eyefinity at 800.942.5353 and request that we block the certified partner's access to your system.
  • Find the proxy user associated with the vendor (Last Name = "WebUserProxy") and remove all roles.
  • If a System Admin user granted the API Partner access through the authentication process with their User ID, that user can change their password in AcuityLogic to disable the API partner access to the system.
  • Follow the instructions below.

To disable access to the Patient Engagement interface

  1. Go to the portal provided to you from the Patient Engagement certified partner.

    A Sign On window opens.

  2. Log into the portal by using the AcuityLogic account user name and password (as verified in Verifying Administrators Are Properly Set Up).


    When you log into the portal, you must append _pm_CompanyID_pm to your user name. For example, if your user name is jsmith and your company ID is 12345, enter the user name jsmith_pm_12345_pm. If you don't know your company ID, contact Eyefinity Customer Care.

  3. Select the information that you do not want the Patient Engagement certified partner to access, and click Don't Allow.


    If an AcuityLogic account was created only to enable access to the Patient Engagement Interface, Eyefinity recommends that you also disable the account's access to AcuityLogic. See To deactivate an employee.

Troubleshooting Tips

When using the Bulk Data API, the data snapshots are stored in the \_SNAPSHOTS folder under a path similar to C:\inetpub\wwwroot\documents\_SNAPSHOTS based on your configuration. These files can be about 1MB per file/per office. Please monitor the\_SNAPSHOTS folder and archive as needed to ensure you have the storage space required.

If the Patient Engagement Interface is not working, check the following issues:

Issue Resolution

The password for the user account that you verified has expired.

Reset the password and re-enable access to the Patient Engagement Interface. See To reset an employee password or reset a locked-out user.

Notes:

  • The password for user accounts assigned only the APIUser role may expire if synchronizations do not occur for 90 days.

  • A user account with the appropriate security role, such as System Admin, must reset the password for user accounts assigned only the APIUser role.

The user account you verified is inactive.

Select the Active check box for the user account in the Employee window.

The user account you verified no longer has the Security Setup or Company Setup setting assigned to it.

Select the System Admin or APIUser role for the user account in the Employee window.

The Patient Engagement certified partner's portal is not working correctly.

Work with the certified partner to ensure that its portal works correctly and that all verified administrators can access it.

Related Topics