Health API Documentation

Introduction

Welcome to Ampliz API documentation. Our REST API allows you to query our vast dataset of healthcare profiles and receive and get an enriched profile you were looking for. Our four main calls are: Search Physician API, which returns physician data based on Physician name, speciality, state and city. Search Health Executive API, which returns health executive data based on fullname, state and city. Get Email and Phone for Physician API which returns contact of particular physician. Get Email and Phone for Health Executive API which returns contact of particular health executive.

As noted before, our APIs are RESTful, and all requests should be made over SSL. The response bodies are encoded in JSON.

Please note that we operate as a search platform, and therefore the information we retrieve is not created or interfered directly by us, rather than retrieved from the web or from contribution of relevant data from our trusted business partners. To learn more about our dataset of business profiles and on the ways we collect and use such business profiles, please read our Privacy Policy.

Note: A credit will be deducted for each successful match. A match is a request that yielded results.

Ampliz API endpoint

https://hcla15.ampliz.com/

Authentication

Requests are authenticated by your API key. When making a call, you’ll have to specify this API key with the Authorization header. Here’s an example:

Note that your API key is what identifies you and your usage, so please don’t share it with anyone outside of your organization.

curl -X GET --header 'Accept: application/json' 'https://hcla15.ampliz.com/amplizhcreadapi/enterprize/get-api-key-for-user'

Errors

Ampliz uses common HTTP response codes to indicate the status of the API request. In case of an error, Ampliz API will return the correspondent code.

HTTP Status codes

200 OK – Successful request
400 Bad request – Badly formatted request
401 Unauthorized – The API key is invalid
403 Unauthorized – Your account is not active. Please contact support
404 Not found – The requested endpoint was not found
412 - The request failed due to invalid syntax that was provided. Please make sure to send a full name field that contains a valid first & last name.
429 Limit reached – You’ve reached your trial limit, please contact support for upgrade
451 - We are unable to process this contact request due to our GDPR regulations.
499 - Request failed due to request timeout.
5XX Server error – There’s a problem on Ampliz end

Search Physician API

The Search Physician API lets you look up a physician data based on his name, speciality, state and city he works in. For example, you can get the physician’s hospital name, email, phone number.

HTTP request

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/search-physician?physicianName=Dana20Tannenbaum&specialty=Ophthalmologist&state=CA&city=North20Hollywood

HTTP parameters

physicianName: RequiredName of the Physician (e.g – Dana Tannenbaum)
specialty: RequiredSpeciality of that physician (e.g - Ophthalmologist)
state: RequiredState of the physician (e.g - CA)
city: RequiredCity of the physician (e.g - North Hollywood)

Physician Attributes

fullName – Full Name of the Physician
speciality – Speciality of the Physician
country – Country of the Physician
city – City of the Physician
state – State of the Physician
zipCode – Zipcode of the Physician
county – County of the Physician
hospitalName – Name of the hospital in which Physician is associated.
phoneNumber – Hidden Contact number of the Physician
email – Hidden Email of the Physician
gender – Gender of the Physician
hospitalId – Unique Id of the Physician associated hospital
physicianId – Unique Id of Physician
provider_Type –

Request example

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/search-physician?physicianName=Dana20Tannenbaum&specialty=Ophthalmologist&state=CA&city=North20Hollywood

Response

{
  "physicianInfoList": [
    {
      "physicianId": "60d17e8b760f081b7bcd0129",
      "hospitalId": "60cccc83760f08cc516ca640",
      "showHospitalLink": "false",
      "fullName": "Dana Tannenbaum",
      "gender": "F",
      "iconLink": "https://s3.console.aws.amazon.com/s3/object/ampliz-public?region=ap-south-1&prefix=Doctor+-F.png",
      "profileIconLink": "",
      "specialty": "Ophthalmologist",
      "city": "North Hollywood",
      "state": "CA",
      "county": "Los Angeles",
      "zipCode": "91602-3457",
      "country": "USA",
      "hospitalName": "Abrazo Central Campus (FKA Phoenix Baptist Hospital)",
      "phoneNumber": ["******"],
      "email": [""],
      "inSavedList": false,
      "provider_Type": null
    }
  ]
}

Search Health Executive API

The Search Health Executive API lets you look up a health executive data based on his name, state and city he works in. For example, you can get the executive’s hospital name, email, phone number.

HTTP request

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/search-health-executive?fullName=Sue%20Masemer&state=MN&city=Minneapolis

HTTP parameters

fullName: RequiredName of the HealthExecutive (e.g – Sue Masemer)
state: RequiredState of the HealthExecutive (e.g - MN)
city: RequiredCity of the HealthExecutive (e.g - Minneapolis)

Health Executive Attributes

fullName – Full Name of the Health Executive
title – Title or designation of Health Executive
country – Country of the Health Executive
city – City of the Health Executive
state – State of the Health Executive
zipCode – Zipcode of the Health Executive
county – County of the Health Executive
hospitalName – Name of the hospital in which Health Executive is associated.
phoneNumber – Hidden Contact number of the Health Executive
email – Hidden Email of the Health Executive
gender – Gender of the Health Executive
hospitalId – Unique Id of the Health Executive associated hospital
executiveId – Unique Id of Health Executive

Request example

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/search-health-executive?fullName=Sue%20Masemer&state=MN&city=Minneapolis

Response

{
  "healthExecutiveInfoList": [
    {
      "executiveId": "60e40027760f08af7176e594",
      "hospitalId": "60cccc83760f08cc516ca640",
      "showHospitalLink": "false",
      "fullName": "Sue Masemer",
      "gender": "F",
      "title": "Manager",
      "iconLink": "https://s3.console.aws.amazon.com/s3/object/ampliz-public?region=ap-south-1&prefix=Execuitve-+F.png",
      "profileIconLink": "",
      "city": "Minneapolis",
      "state": "MN",
      "county": "",
      "zipCode": "55407",
      "country": "USA",
      "hospitalName": "Abrazo Central Campus (FKA Phoenix Baptist Hospital)",
      "phoneNumber": ["******"],
      "email": [""],
      "inSavedList": false,
      "provider_Type": null
    }
  ]
}

Get Email And Phone For Physician API

The Get Email and Phone For Physician API gets you his email and phone number based on Physician Id.

HTTP request

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/get-email-and-phone-for-physician?physicianId=60d17e8b760f081b7bcd0129

HTTP parameters

physicianId: RequiredUnique Id of Physician which can be get from search-physician API (e.g – 60d17e8b760f081b7bcd0129)

Physician Attributes

email - Email Address of the Physician
phoneNumber – Phone Number of Physician

Request example

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/get-email-and-phone-for-physician?physicianId=60d17e8b760f081b7bcd0129

Response

{
  "email": ["[email protected]"],
  "phoneNumber": ["777-333-6666"]
}

Get Email And Phone For Executive API

The Get Email and Phone For Executive API gets you his email and phone number based on Executive Id.

HTTP request

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/get-email-and-phone-for-executive?healthExeId=60e40027760f08af7176e594

HTTP parameters

healthExeId: RequiredUnique Id of Health Executive which can be get from search-health-executive API (e.g - 60e40027760f08af7176e594)

Health Executive Attribute

email - Email Address of the Health Executive
phoneNumber – Phone Number of Health Executive

Request example

GET https://hcla15.ampliz.com/amplizhcreadapi/enterprize/get-email-and-phone-for-executive?healthExeId=60e40027760f08af7176e594

Response

{
  "email": ["[email protected]"],
  "phoneNumber": ["888-887-6666"]
}

Legal Guidelines

We work diligently to comply with applicable laws and strive to safeguard individual rights. Thus, we require you to specify for what purpose you obtain our data in order to inquire if the purpose is lawful.

In addition, we specified hereunder important guidelines which applicable to all our API customers and we request that you shall respect them:

You shall agree to the terms of our API Agreement and our Privacy Policy.
You should not violate privacy rights or intellectual property rights of any third party.
You should not use our data for purposes of cookie tracking, ad exchanges, ad networks, data brokerages, SPAM or any other purpose in violation of any applicable law.
You shall use our data in compliance with applicable data privacy and protection laws.
You shall take adequate security measures to safeguard personally identifiable information you receive from us.
You shall respect individuals’ privacy rights and delete personally identifiable information you obtain from us, in case you receive a notification from an individual requiring that you shall delete it.
You shall take measures to guarantee that you have the right to upload and share with us information relating to individuals.