Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Software Release Version

DrCloudEHR 2020

API Description

The DrCloud MU3 API is a web interface to the DrCloudEHR server that is used to request and receive CCDS data-based, CCDS-compliant API that is used to request and receive data from a DrCloudEHR server.

  • When a user 'logs in' to the API, a token is received that can be used to authenticate later API calls.
    • User creation is handled by the existing User management interface.
    • Tokens are valid for up to 60 minutes.   However, a user may request a new token at any time.
  • Parameters are passed to the API scripts using POST variables.
    • The programs written to test the API are PHP scripts that use libcurl to communicate with the API scripts.
  • The scripts return requested MU3 data formatted as an XML file.
    • For API calls that request MU3 section data, the returned files are generated by DrCloud's CCDA reporting code.

Basic Workflow

  • User 'logs in' to the API by running login.php.
    • A token is received that can be used to authenticate later API calls.
    • User creation is handled by the existing User management interface.
    • Tokens are valid for up to 60 minutes.   However, a user may request a new token at any time.
  • If the user does not know the patient's ID, it can be found by running either patientlist.php or patientsearch.php.
  • getpatdata.php can then be run to query the API for the patient's CCDS data.

...

This is a legal agreement ("Agreement") between you, the "User", and Ensoftek EnSoftek Inc ("Company").  BY ACCEPTING THIS AGREEMENT, YOU ARE CONSENTING TO BE BOUND BY ITS TERMS.   . Read the terms of the agreement here. 

Definitions

As used herein: the "Software" means the DrCloudEHR Application Programming Interface (API).

...

All Users SHALL possess an active DrCloudEHR license agreement.   Use of this Software SHALL BE COVERED BY THE TERMS OF THAT LICENSE AGREEMENT.

Limitation of Liability

Limitation of Liability for this Software SHALL BE COVERED BY THE TERMS OF THAT LICENSE AGREEMENT.

...