Close  

   
Please enter your details to view the document
  Required field marks with *
 
First Name*
 
 
Last Name*
 
 
Organization / Clinic Name*
 
 
Phone Number *
 
 
Email Address*
 
 
Comments
 
 
 
Zoom MD
Home > Services > ZoomMD API
ZoomMD Google Plus+ ZoomMd Twitter ZoomMD Facebook
We are ready to help Please call us at 800-992-6382

ZoomMD API

API Specification Document

Overview

 This Document discusses ZoomMD OpenAPI 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 Common Clinical Data Set, in the context of meeting the Meaningful Use Stage 3 requirements.

 Intended users for this API are patient’s or their Authorised 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 difine the xml request schema for all the request defination.

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

Method

URL            

POST

https://api.zoommd.com/API/APIAccess/authenticate/

XML Request Example

<APIAccess>

<username>hard</username>

<password>testall1</password>

</APIAccess>

Response

<APIAccess>

<accessToken>accessToken<accessToken>

<status>Success</status>

</APIAccess>

2.getData

getData method retuns either complete patient data or specific category data based on parameters sent.

Following are the tags used for different parameters.

1. send value true in completeData tag to get patient complete data.

2. send categories in one or more searchCriteria tags to get specific category data of patient.

3. send values in startData and endDate tags to get patient data recorded in specific date range.

Request

Method

URL            

POST

https://api.zoommd.com/API/APIAccess/getData/

XML Request Example(Complete Data)

<APIAccess>

<accessToken>f6250d63</accessToken>

<completeData>true</completeData>

</APIAccess>

Response

<APIAccess>

<accessToken>f6250d63</accessToken>

<completeData>true</completeData>

<ccdaFile>base64FormatPatientData</ccdaFile>

<status>Success</status>

</APIAccess>

Request

Method

URL            

POST

https://api.zoommd.com/API/APIAccess/getData/

XML Request Example(Specific Category Data)

<APIAccess>

<accessToken>f6250d63</accessToken>

<searchCriteria>Problems</searchCriteria>

<searchCriteria>Medications</searchCriteria>

<searchCriteria>Procedures</searchCriteria>

</APIAccess>

Response

<APIAccess>

<accessToken>f6250d63</accessToken>

<searchCriteria>Problems</searchCriteria>

<searchCriteria>Medications</searchCriteria>

<searchCriteria>Procedures</searchCriteria>

<ccdaFile>base64FormatPatientData</ccdaFile>

<status>Success</status>

</APIAccess>

Request

Method

URL            

POST

https://api.zoommd.com/API/APIAccess/getData/

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 shoud not disable, hack or otherwise interfere with any security, verification or authentication mechanisms implemented in or by ZoomMD.

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

5% Medical Billing & Free EMR* !

Ask us for a free billing analysis & how we can improve your collections !

*Conditions Apply
Name
Email
Phone