Company Certification and Awards

ZoomMD API

API Specification Document

Overview

 This Document discusses ZoomMD API Version 4.1 and its API methods for third party developers who are developing software applications for accessing Patient Health Information (PHI). ZoomMD API allows other health IT applications to make read-only data requests for patient health information that is part of the USCDI data elements, in the context of meeting the Cures Update.

 Intended users for this API are patients and/or their Authorized representatives. Patients will obtain user credentials from the practice or health care provider.

API Method Details :

1.authenticate

Request

Response

2.getData

Request

Response

Please go through the below attached XSD file, which will define the xml request schema for all the request definition.

Click here for XSD file

Methods

1.authenticate

Authenticate the user credentials with the system and get the accessToken, which must be sent with all client requests. The accessToken helps the server to validate the request source and session.

If the user is valid, we will return success message in status tag along with accessToken. If the user is invalid, we will return failure message in status tag along with accessToken.

Request

XML Request Example

<APIAccess>

<username>hard</username>

<password>testall1</password>

</APIAccess>

Response

<APIAccess>

<accessToken>accessToken<accessToken>

<status>Success</status>

</APIAccess>

2.getData

getData method returns complete patient data based on parameters sent.

Following tag used to get data for specific date range.

1. send values in startDate and endDate tags to get patient data recorded in specific date range.

Request

XML Request Example

<APIAccess>

<accessToken>f6250d63</accessToken>

<completeData>true</completeData>

</APIAccess>

Response

<APIAccess>

<accessToken>f6250d63</accessToken>

<completeData>true</completeData>

<ccdaFile>base64FormatPatientData</ccdaFile>

<status>Success</status>

</APIAccess>

Request

XML Request Example(Specific Date Range Data)

<APIAccess>

<accessToken>f6250d63</accessToken>

<completeData>true</completeData>

<startDate>yyyy-mm-dd</startDate>

<endDate>yyyy-mm-dd</endDate>

</APIAccess>

Response

<APIAccess>

<accessToken>f6250d63</accessToken>

<completeData>true</completeData>

<startDate>yyyy-mm-dd</startDate>

<endDate>yyyy-mm-dd</endDate>

<ccdaFile>base64FormatPatientData</ccdaFile>

<status>Success</status>

</APIAccess>

Terms and Conditions

The ZoomMD API Platform web link has the most up-to-date documentation. Developers wishing to share the documentation may do so via linking other developers to the web link.

All of ZoomMD publicly available APIs are accessible through RESTful HTTPs calls. You can use programming language of your choice, Java, JavaScript, C, etc., to interact with ZoomMD API as exchange of data happens in XML format, which is independent of programming language.

Developers are responsible for the products developed and how the products connect to the ZoomMD API software. Developers are also responsible for complying with all applicable laws regarding patient data.

Applications created to access ZoomMD API should not disable, hack or otherwise interfere with any security, verification or authentication mechanisms implemented in or by ZoomMD.

Note: We will provide the response inside <ccdaFile> tag, which is in base64 encoded format, once you decode that you will get appropriate xml file.