Software Release Version
DrCloudEHR 2020, 2025
The DrCloud MU3 API is a web-based, USCDI-compliant API that is used to request and receive data from a DrCloudEHR server.
Basic Workflow
This table shows the API for Meaningful Use Stage 3 validation. Most of the API calls make use of POST variables. Browser-based HTML forms can be used to access these, though we have been able to use both PHP scripts, as well as Postman (https://getpostman.com) to test the API.
Filename | POST Variables | Returns (status = 0) | Errors (status != 0) | Comments | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
login.php |
| An XML file containing an array of records, consisting of:
|
| Generates the API session token. Token is valid for 1 hour, but you can generate a new token at any time before then. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
patientlist.php |
| XML file containing an array of records containing:
|
| Get a list of all patients. Used to find patient ID's, if you don't know the patient's name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
patientsearch.php |
| An XML file containing:
|
| Search for a patient by first name or last name. You must specify a last name if you want to specify a first name. example POST variables: firstname = "Artemis", lastname="Osborne" Returns a list of patient entries that match at least one of the search parameters. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getpatdata.php |
If enable_date_filter is not set, date filtering will be enabled. Note that the code simply checks for the existence of enable_date_filter. Set this to "1", so that it doesn't confuse people. The date filter applies to the following sections:
If enable_data_filter is set and start_date is not set, the date 1970-01-01 will be used as the start date. If enable_data_filter is set, and end_date is not set, the current date will be used as the end date. Note that this date is set by the server and not the client. | A JSON file containing data for the requested section. Selecting any of the "demographics" sections (1-6) will return all of the demographics sections. Selecting any of the other sections will also return the Demographics sections in addition to the selected section. If section_num was set to zero, or no section_num was specified, all sections will be returned. |
If section 14 is selected:
| Returns the USCDI sections for MU Stage 3. Section numbers
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
get_ccda.php |
| Returns the USCDI sections as a C-CDA file for the selected patient, with optional start/end date constraints. |
|
Postman (https://www.getpostman.com) can be used to test the API. The DrCloud MU3 collection is available on request.
The "Login" request runs the "login.php" script, which must always be run before running any other Request, as documented above.
"Request CCDA" returns a Zip file containing the CCDA XML file, so instead of pressing the "Send" button, click on the little down arrow to the right, which will display the "Send and Download" button. Clicking on that will allow you to download the file.
This is a legal agreement ("Agreement") between you, the "User", and Ensoftek Inc ("Company"). BY ACCEPTING THIS AGREEMENT, YOU ARE CONSENTING TO BE BOUND BY ITS TERMS.
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.
The Company may limit the number of persons that can use the Software.
Please refer to https://drcloudehr.com/promoting-interoperability-transparency-and-disclosure-requirements/
If you become aware of any unauthorized access or use of the Software, you shall immediately notify the Company.