This wiki is used by Health Market Science (HMS) to provide documentation on the use of HMS APIs for access to HMS's comprehensive data on the health care industry. For more information on HMS's products, reference the company web site: http://www.healthmarketscience.com/
The HMS APIs use a REST interface, which is reflected in the documentation provided.
In order to use any of the HMS APIs, you must have security credentials consisting of a Key and Secret. This requires a contract with HMS. If you are with a company that currently has a contract with HMS, please contact your HMS sales representative for information on the options for API usage and to get the required security credentials; otherwise, for further information please contact HMS via e-mail:
E-mail Address: apisupport@healthmarketscience.com
Subject Line: API Contract Information
Include any other contact information you want HMS to use in reaching you. An HMS representative will contact you within one business day with information regarding contract options and supplying security credentials so that you can make use of the HMS APIs.
HMS API services use the following RESTful web service call elements:
Method = HTTP Method. The appropriate methods GET, PUT, etc. are identified in the section documenting each of the services provided.URL = URL for each service.Body = Request body. Not always present.Response = Possible responses will be documented with each service.URL elements for HMS APIs are generally structured as follows: Root/Version/RequestSecurity
Root = https://api.hmsonline.com
Version = Version Number (Initial Version Number=v1)
Request = Request being made to API (See specific commands for details)
Security = Security string to validate request (See Security Credentials for details)
Root = https://api.hmsonline.com
Version = v1
Request = search/masterfile?
Security = timestamp=1369844777731&key=EU2BD6eHBQeUMpMxDW9dmg==&signature=8qrFmQbQgILzdDeQfbJTxHXeZvE=
Yields the following URL:
https://api.hmsonline.com/v1/search/masterfile?timestamp=1369844777731&key=EU2BD6eHBQeUMpMxDW9dmg==&signature=8qrFmQbQgILzdDeQfbJTxHXeZvE=Body in this case will determine the actual query to perform. To query all records, use:
Body = {"match_all":{}}
Note: All security values shown here and throughout this documentation are for illustration purposes only and will not work as shown. See Security Credentials for more information.
HMS employs version control of the APIs documented here. The version number is specified in the URL of each API call. The same version number is maintained across all APIs. Currently, only the initial release version v1 exists. As improvements are made and future versions of the APIs are released, this will be documented here.
v1