Configuring Medicus for API Connections (App Directory)

Michael Barrow -

Purpose

The App Directory lets practice staff control which third-party applications can access the practice's data through the Medicus Transactional API. From here you can enable an app that has been agreed with Medicus, review which apps are currently enabled, see apps that have been disabled again, and review a log of every API request made against your instance. This is separate from Bulk Data Extracts, which cover scheduled file-based data exports to integration partners rather than live API access by third-party applications.

 


Accessing the App Directory

Navigate to Modules > Data Sharing & Integrations, then under Connected Apps select App Directory.

The App Directory page has three tabs:

  • Currently Enabled Apps: apps that are enabled and can currently access your instance of Medicus.
  • Previously Enabled Apps: apps that were enabled at some point but have since been disabled.
  • API Log: a log of API activity against your instance.

 


Enabling the Black Pear App

Third-party applications are configured centrally by Medicus in agreement with each integration partner, in the same way as bulk data extracts. Enabling an app in the App Directory is the explicit step that grants it access to your practice's data.

To enable an app:

  1. From the Currently Enabled Apps tab, select Enable app.
  2. A list of the apps available to your practice that are not already enabled is shown. Select Black Pear.
  3. Review the information shown about the app before continuing.
  1. Select Enable app to confirm.

 

The exact wording of the information shown in this review step is supplied per application by Medicus and the integration partner, so it varies by app.

 

All Enable Apps 

The app then appears in the Currently Enabled Apps tab, showing the app name, the date it was enabled, and which staff member enabled it.


 

 

 

 

 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk