DermEngine Integration for Best Practice


This page explains how to set-up the DermSync software to sync patient demography from the Best Practice software to DermEngine.

While using this software, patients opened on Best Practice will be transferred to the DermEngine platform. On DermEngine, images and lesions can be added to each patient. After the visit is over, you can also export a PDF report from DermEngine to Best Practice.

In order for DermSync to automatically receive updates and patches, Run from startup needs to be selected after the installation.



  • A Windows machine with Best Practice Software installed
  • The user needs to have permission to install DermSync
  • The database browser password is required to read patient data from the Best Practice database. This password can be set for the first time in Best Practice. From the menu bar at the top, select "Setup", then select "Configuration".
    From the left side menu, select "Database".
  • If you are using BP Jade or a version of BP after Jade, you will need to click  'Setup third-party integrations' and then from the window that appears select 'MetaOptima (DermEngine)'setup third party-1

    save third party
  • Alternatively, if you are using BP Indigo or a previous version to BP Indigo, click on the button "Database browser" to set the password. You will enter this password into DermSync's database settings window.

Installation Steps:

  1. On the server* computer, download the integration software (DermSync)
    For Windows
    *Not recommended for terminal servers
    Learn about the differences by clicking here

  2. Install DermSync on your machine (Default Folder: C:\Program Files (x86)\DermSync\).
    Users need to have write permissions on this folder.
    Note: We recommend installing DermSync for all users.

  3. Double click to run the DermSync application.
  4. Enter your DermEngine credentials including your email and either your password or access key.
    If you don't already have an account, visit https://app.dermengine.com/ or download the mobile app.
    To learn how to create an account click here

    The access key can be retrieved on DermEngine under the Account menu.
  5. Select "Best Practice" from the drop down list


  6. You will be prompted to fill in database settings (this window can also be found through DermSync by clicking Settings > Database settings through the menu)
    There are two differences based on what version of BP you are using but in both cases you will enter the server name which will include the IP address or name of the machine that Best Practice Server is installed on. If Best Practice is installed on the local machine, server name will be (local)\BPSINSTANCE. The server name can also be found in BP under Setup > Configuration 

    For BP versions Jade or after:
    • Have 'BP Jade or after' selected at the top.bp jade

    Additionally, for BP versions Indigo or before:
    • Select 'BP Indigo or before' at the top.
      Password: Enter the database browser password set in the DermSync application.bp indigo
  7. Continue to the next sections to set up the sync for patients and reports



Transfer Patients

Patients will be sent to DermEngine when the clinical visit starts, the timer next to "Finalize visit" will show.
Patients will be available on your Patient List on DermEngine and the mobile apps.

Best Practice Clinical View

There are 3 optional filters that can be set up:
  1. Filter by providers
  2. Filter by appointment type
  3. Filter by locations (clinics)
To filter by Providers:
  • Filtering the export based on the providers limits the patients sent to DermEngine.
  • By default, if no selection is saved, patients from the current logged in doctor on BP will be transferred.
  • When a new doctor is added to BP, they need to be added to this list.
  • Click the application icon in Taskbar (by default the bottom right of the screen)
    Select settings and and then "Filter by providers"

  • Select from the list, providers whose patients you would like to transfer to DermEngine:
To filter by appointment:
  • By default, there is no filtering and all the patients will be sent to DermEngine. Patients can be filtered by appointment type (requires DermSync v2.5 or higher).
  • On BP, add a new appointment. Select “Appointment type” from the list.

  • On DermSync, click the application icon in Taskbar (by default at the bottom right of the screen).
    Select Settings and then "Filter by appointment types"
  • Select from the list, appointment types whose patients you would like to transfer to DermEngine.
  • Patients who have had this appointment type at their most recent appointment will be synced when a new clinical visit starts.
To sync to multiple clinics:
  • By default all patients are synced to the same clinic, selected after the user logs in.
  • DermSync can also be set up to sync patients from different Best Practice locations to different clinics (requires DermSync version 2.25 or later)
  • Click on the taskbar icon, then select Settings -> Change clinic selection
  • For each Best Practice Location, select a clinic on DermEngine.
  • The user logged on to DermSync needs to be a clinic member for the clinic to appear on this list.
  • Click "Save" to save the selection.



Import Timeline Reports to Best Practice:


  1. Create a folder that will be used for patient transfer files, and allow write access for any accounts using Best Practice.
  2. On Best Practice, set up Results Import. From the menu bar at the top, select "Setup", then select "Configuration". From the left side menu, select "Results import".
    Check the box for "Import investigation results on this computer" and add the folder to the "Report file search paths".


  3. On the Best Practice Server, run the BPLink utility to automatically check for results every 5 minutes.
  4. Set up DermSync. Click on the taskbar icon, then select "DermEngine report import directory". Select the same path in DermSync.




  1. On DermEngine web, create a Timeline Report. Press the button to Print Report and export to Best Practice.


    DermSync will save the report to the selected folder. When Best Practice imports the report, the file will be deleted automatically.
  2. After this, there are two different ways you can import reports exported from DermEngine to your selected folder.
    • One way is to have 'BPLink' utility running. This utility will check every 5 minutes to see if there are any reports in the folder you set previously (under 'Report file search paths') and if found will import them into Best Practice and remove them from the folder.
    • Alternatively, to avoid waiting, you can manually import reports from your selected folder by selecting View > Incoming Reports from the main Best Practice screen. This will force an import of any reports found in the folder that you set.

      incoming_reportsHere you will find that the doctor under the 'Addressed To' column is the logged in doctor on DermEngine. The doctor under 'Allocated To' is set on BestPractice.
  3. Best Practice will notify that there are unchecked reports for the patients the next time the patient is open. When you open a patient and they have unchecked reports, you will see it indicated to you as below:bp-timeline-unchecked-notification
  4. Next, the report can be found in the patient's file, under Clinical > Unchecked reports.