CareDash REST API Documentation (1.1.11)

CareDash Technical Support: support@caredash.com

Introduction

Welcome to the reference documentation for the CareDash REST API!

REST is a web-service protocol that lends itself to rapid development by using everyday HTTP and JSON technology.

You should find what you need in order to access the listings database for Providers, Facilities and Reviews using the CareDash API.

If you should have any questions along the way please don't hesitate to contact your CareDash Account Representative or a member of our Technical Support Team at support@caredash.com.

The Basics

The CareDash REST API provides access to the CareDash listing database and a broad set of operations and resources that allow you to:

  • Synchronize Provider or Facility information from your database to CareDash in real time

  • Search for providers or facilities in the CareDash database by filtering on a variety of fields including

    • Name
    • Address
    • NPI number
  • Claim a Provider or Facility directly from the REST interface

  • Update fields for a Provider or Facility you have claimed

  • Submit a reply to a CareDash user's review of a Provider.

For the API developer, CareDash is a publisher of healthcare provider listing information. Listings are essentially the business information associated with each provider or facility. Through the use of the CareDash API, you are able to programmatically claim providers or facilities that your organization is responsible for and make sure information regarding them is accurate and properly shown on the CareDash site.

A typical workflow for interacting with a Provider may involve the following steps:

  1. Use the /providers/search method to find providers of interest

  2. Use a GET request to /providers/{npi} to pull detailed information on any individual provider using their NPI and determine which fields/attributes require updates.

  3. Use a POST request to /providers/{npi} to claim the provider and convert to your "owned" listing

  4. Use a PATCH request to/providers/{npi} to subsequently update the provider with new data including headshots, summary text, address, phone, etc. As long as you remain the "owner" of the listing data, you may update that provider's data at any time.

  5. Use the reply /providers/reviews/{review-id}/reply method to submit a response to reviews on any of your claimed providers.

  6. Use a DELETE request to /providers/{npi} to unclaim a provider at any time if you no longer wish to manage their data.

Base Url

The production CareDash API can be found at 'https://api.caredash.com/v1/'.

The sandbox version can be found at 'https://api-sandbox.caredash.com/v1/'.

The production URL is used in the sample code snippets below and you will need to modify that accordingly if you are using those snippets on the sandbox server.

Authentication

The API validates every request with a bearer token passed in to the Authorization header. An invalid or missing token in the header will result in a 401 Forbidden error.

  curl -X GET -H 'Authorization: Bearer 1234' https://api.caredash.com/v1/admin/ping

Authorization Tokens are issued by CareDash and are unique for each Partner using the API. A token is associated with various allowed methods (e.g. read, write, claim) on various resources (e.g. providers, facilities, reviews). Your Account Representative will coordinate which set of permissions will be associated with your token.

accessKey

Authorization Tokens are issued with access keys and permissions as described in the following table:

Access Key Description
reference:read Allow read access to reference data
provider:read Allow read access to providers
provider:write Allow write access to providers
provider:claim Allow access to claim and unclaim providers
facility:read Allow read access to facilities
facility:write Allow write access to facilities
facility:claim Allow access to claim and unclaim facilities
review:read Allow read access to reviews
review:reply Allow access to reply to review
reply:revoke Allow access to revoke a submitted reply

Required and nullable fields

Throughout this documentation, they keywords required and nullable are used to more fully describe fields in both requests and responses.

Requests must include all fields marked as required. Fields in the request may be null as indicated by the nullable tag in this documentation.

Responses will include all fields marked as required. If the response field is not marked as nullable, the field is guaranteed to be populated.

Releases

v1.1.0

  • Removes the requirement that a Provider must be claimed claimed in order to read any review Replies associated with them

  • Adds aggregate statistics about a provider's reviews to the /providers/{npi}/reviews endpoint

    • This includes, for example, the number of reviews and the overall rating across all reviews for the provider.
    • See the documentation of that endpoint for details.
  • Adds the ability to search for providers or facilities by slug

  • Adds a timestamp field in the response for /providers/reply/{reply-id}

    • This fields reflect the most recent time among when the Reply was created, processed or had its content changed. The timestamp will align with the date shown on CareDash.com for the Reply.
  • Significantly speeds up search requests for Providers and Facilities

    • Note that when a change is made to our internal database (e.g. via Provider or Facility patch requests) it could take up to 5 minute for that change to propagate and be reflected in the search behavior. Any data changed by patch requests is still immediately reflected in GET requests to /providers/{npi} and /facilities/{id}
  • Patch and post requests with unsupported parameters in the request body now return a 400 error.

    • Previously these requests could return a successful response which is potentially misleading and can obfuscate typos in request parameters.
  • Adds an active field to the images returned in a Provider or Facility details request (/providers/{npi} and /facilities/{id}).

    • This provides more visibility on the status of images submitted via a patch request.
    • When you submit an image through a patch request, the image will be inactive to begin with but will become active shortly after it is processed on our end (typically this is a matter of seconds). The active field reflects this.
  • Allow appropriate fields to be set to null in Provider and Facility patch requests

    • Previously, no fields could be set to null and now non-essential fields can be set to null.
    • A null value, an empty string or an empty list in the request may be used depending on the type of the field.

Admin

Admin endpoints.

Method Endpoint Description
GET /admin/ping Return CareDash API meta data including version number
GET /admin/docs Return CareDash API documentation in HTML form

Documentation

get /admin/docs
http://localhost:5001/v1/admin/docs
https://localhost:5001/v1/admin/docs

Returns HTML documentation on the CareDash API.

Responses

200

Successfully loaded html page.

Ping

get /admin/ping
http://localhost:5001/v1/admin/ping
https://localhost:5001/v1/admin/ping

Return meta data about the CareDash API including version number.

Authorizations:
accessKey (admin:read)
header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/admin/ping'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "version": "string"
}

Reference

These endpoints provide general reference data that can be used to inform Provider or Facility updates.

Method Endpoint Description
GET /reference/conditions Return a list of CareDash-supported conditions
GET /reference/insurances Return a list of CareDash-supported insurance carriers
GET /reference/languages Return a list of CareDash-supported languages
GET /reference/specialties Return a list of CareDash-supported medical specialties

Conditions

get /reference/conditions
http://localhost:5001/v1/reference/conditions
https://localhost:5001/v1/reference/conditions

CareDash maintains a list of conditions that are supported. This endpoint returns a list of those conditions. Ths 'slug' field is used for submitting a list of conditions when updating a Provider.

Authorizations:
accessKey (reference:read)
header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/reference/conditions'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "conditions":
    [
    ]
}

Insurance carriers

get /reference/insurances
http://localhost:5001/v1/reference/insurances
https://localhost:5001/v1/reference/insurances

CareDash maintains a list of insurance carriers that are supported. This endpoint returns a list of those insurance carriers. Ths 'slug' field is used for submitting a list of insurance carriers when updating a Provider.

Authorizations:
accessKey (reference:read)
header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/reference/insurances'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "insurance_carriers":
    [
    ]
}

Languages

get /reference/languages
http://localhost:5001/v1/reference/languages
https://localhost:5001/v1/reference/languages

CareDash maintains a list of languages that are supported when updating a Provider or Facility. This endpoint returns a list of those languages.

Authorizations:
accessKey (reference:read)
header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/reference/languages'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "languages":
    [
    ]
}

Specialties

get /reference/specialties
http://localhost:5001/v1/reference/specialties
https://localhost:5001/v1/reference/specialties

CareDash maintains a list of specialties that are supported. This endpoint returns a list of those specialties. Ths 'slug' field is used for submitting a list of specialties when updating a provider.

Authorizations:
accessKey (reference:read)
header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/reference/specialties'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "specialties":
    [
    ]
}

Facilities

A Facility in the CareDash model represents an organization at a specific address that gives medical services to the community. We track and manage many attributes for a Facility. For example address, images, summary text, and social medial links.

Method Endpoint Description
GET /facilities/search Find Facilities based on search criteria and return a summary set of attributes
GET /facilities/{id} Returns a detailed set of attributes for a Facility
POST /facilities/{id} Claim a Facility which is required to perform subsequent actions for that Facility (e.g. edit Facility fields)
PATCH /facilities/{id} Edit fields associated with a Facility (e.g. address, images etc.)
DELETE /facilities/{id} Remove an existing claim on a Facility. Appropriate if you are no longer managing data for the Facility.

Facility details by ID

get /facilities/{id}
http://localhost:5001/v1/facilities/{id}
https://localhost:5001/v1/facilities/{id}

Detailed information about a Facility.

Authorizations:
accessKey (facility:read)
path Parameters
id
required
string

Resource ID

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

404

Facility not found

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/facilities/5w0gkn9v9r7y72mo'

Response samples

application/json
Copy
Expand all Collapse all
{}

Claim a facility

post /facilities/{id}
http://localhost:5001/v1/facilities/{id}
https://localhost:5001/v1/facilities/{id}

Claim a Facility in the CareDash database so that you can make edits to that Facility's data.

Authorizations:
accessKey (facility:claim)
path Parameters
id
required
string

Resource ID

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful Facility claim

403

Permission denied

404

Facility not found

Request samples

Copy
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json'
--header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/facilities/5w0gkn9v9r7y72mo'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "type": "OK",
  • "message": "Successful Facility claim for ID {id}"
}

Update a Facility's data

patch /facilities/{id}
http://localhost:5001/v1/facilities/{id}
https://localhost:5001/v1/facilities/{id}

The PATCH request is used to modify a Facility already claimed by you. Any number of fields may be included in the request body. Fields not included in the request body are not affected and will retain their current values in the database.

If any fields in the payload fail validation, no updates will be processed. A response will be returned with a message describing the first of any validation failures encountered.

Passing a null value for a nullable field will remove the existing data in that field for the Facility.

  • If the field is a string field, a null value or an empty string may be passed to remove the existing data
  • If the field is an array field, a null value or an empty array may be passed to remove the existing data
Authorizations:
accessKey (facility:write)
path Parameters
id
required
string

Resource ID

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Request Body schema: application/json
accepting_new_patients
boolean (AcceptingNewPatients) Nullable

True if accepting new patients

address
object (RequestFacilityAddress)

Address fields will completely replace the address fields on the CareDash Facility. All fields except 'address_2' are required. If 'address_2' is not specified, the existing value for 'address_2' will be removed.

Address changes to Facilities are verified to ensure they match a real US address that mail could be delivered to. If the submitted address fails verification, a 400 error will be returned along with details on why the address could not be verified.

Common reasons for verification failure:

  • If a building contains multiple entities, the 'address_2' field is needed to differentiate them
bike_parking
boolean (FacilityBikeParking) Nullable

True if bike parking is available.

blog
string (Blog) Nullable

The full URL link to a related blog site

emergency_services
boolean (FacilityEmergencyServices) Nullable

True if emergency services are available

facebook
string (Facebook) Nullable

The full URL link to a related Facebook page

fax
string (Fax) Nullable

10 digit fax number

history
string (FacilityHistory) <= 2000 characters Nullable

A description of the history of the Facility

hours_of_operation
Array of object (HoursOfOperation) Nullable

Hours open. There is a strict format required for this array of values. Expand the object at left to see details.

how_to_find
string (HowToFind) <= 1000 characters Nullable

Additional information on locating the address

images
Array of object (RequestFacilityImages)

A list of image objects to add to a Facility. A Facility can have only one image of type 'profile'. If a 'profile' image exists for the Facility on CareDash already, it will be overwritten. Any 'gallery' images included in this list will be added to the existing gallery images. Finally, the images submitted here must not have the same 'url' as any existing images on the facility (viewable via /facilities/{id}).

imaging
boolean (FacilityImaging) Nullable

True if imaging services (e.g. radiology) are available

instagram
string (Instagram) Nullable

The URL link to an Instagram account

insurance_url
string (FacilityInsuranceURL) Nullable

The full URL to a page describing insurances accepted

languages
Array of string (RequestLanguages) Nullable

A list of languages. This list will completely replace any existing languages. The allowed languages can be found at /reference/languages

linkedin
string (LinkedIn) Nullable

Full URL to an associated LinkedIn profile

lgbtqia_friendly
boolean (LGBTFriendly) Nullable

True if the services are LGBTQIA friendly

lgbtqia_friendly_comment
string (LGBTFriendlyComment) <= 100 characters Nullable

Additional comments regarding LGBTQIA friendly services

medicare
boolean (Medicare) Nullable

True if Medicaid is accepted

medicaid
boolean (Medicaid) Nullable

True if Medicare is accepted

mission
string (FacilityMission) <= 2000 characters Nullable

A description of the mission of the Facility

name
string (FacilityName)

Name of this Facility

parking
string (FacilityParking) Nullable
Enum:"free" "paid" "no" ""

An indication of the type of parking available

patient_portal_link
string (FacilityPatientPortalLink) Nullable

The full URL to an associated online patient portal

pharmacy
boolean (FacilityPharmacy) Nullable

True if the Facility includes an on-site pharmacy

pinterest
string (Pinterest) Nullable

The URL link to a related Pinterest account

policies
string (FacilityPolicies) <= 2000 characters Nullable

A description of the Facility policies

phone
string (Phone)

10 digit phone number

referral
boolean (Referral) Nullable

True if referals are needed to make an appointment

scheduling_link
string (SchedulingLink) Nullable

The full URL to a page to schedule an appointment

short_summary
string (FacilityShortSummary) <= 75 characters Nullable

A short phrase that appears under the Facility name. Limited to 75 characters.

site_url
string (SiteURL) Nullable

The full URL to an associated website

snapchat
string (Snapchat) Nullable

The full URL to a related Snapchat account

summary
string (FacilitySummary) <= 5000 characters Nullable

Summary text that appears in the 'Overview' section of the Facility's profile page

technology
string (FacilityTechnology) <= 2000 characters Nullable

A description of the technology used at the Facility

transgender_safe_space
boolean (TransgenderSafeSpace) Nullable

True if the care is a transgender safe space

transgender_safe_space_comment
string (TransgenderSafeSpaceComment) <= 100 characters Nullable

Additional comments regarding transgender safe space

twitter
string (Twitter) Nullable

The full URL to a related twitter feed

walk_in
boolean (FacilityWalkIn) Nullable

True if the Facility accepts walk in patients

wheelchair
boolean (FacilityWheelchair) Nullable

True if the Facility is wheelchair accessible

wifi
string (FacilityWifi) Nullable
Enum:"free" "paid" "no" ""

An indication of the type of Wifi available

videos
Array of string (RequestVideos) Nullable

The full URLs to externally hosted videos. This list of URLs will completely replace any existing videos. The videos must be hosted on either Youtube or Vimeo.

Responses

200

Update successful

400

Bad request

403

Facility not claimed

404

Facility not found

Request samples

application/json
Copy
Expand all Collapse all
{}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "type": "OK",
  • "message": "Successful update for Facility with ID {id}"
}

Remove a facility claim

delete /facilities/{id}
http://localhost:5001/v1/facilities/{id}
https://localhost:5001/v1/facilities/{id}

The DELETE request is used to remove a Facility from your control.

Authorizations:
accessKey (facility:claim)
path Parameters
id
required
string

Resource ID

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful claim removal

403

Facility not claimed

404

Facility not found

Request samples

Copy
curl -X DELETE --header 'Accept: application/json'
--header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/facilities/5w0gkn9v9r7y72mo'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "type": "OK",
  • "message": "Facility with ID {id} is now unclaimed"
}

Providers

A Provider in the CareDash model represents an individual that gives medical services to the community. We track and manage many attributes for a Provider. For example NPI, first/last name, address, specialties, images, and so on.

Method Endpoint Description
GET /providers/search Find Providers based on search criteria and return a summary set of attributes
GET /providers/{npi} Returns a detailed set of attributes for a Provider
POST /providers/{npi} Claim a Provider which is required to perform subsequent actions for that Provider (e.g. edit Provider fields or submit a response to a review)
PATCH /providers/{npi} Edit fields associated with a Provider (e.g. address, specialties, images etc.)
DELETE /providers/{npi} Remove an existing claim on a Provider. Appropriate if you are no longer managing data for the provider.

Provider details by NPI

get /providers/{npi}
http://localhost:5001/v1/providers/{npi}
https://localhost:5001/v1/providers/{npi}

Detailed information about a Provider.

Authorizations:
accessKey (provider:read)
path Parameters
npi
required
integer

NPI of the provider

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful response

404

Provider not found

Request samples

Copy
curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/providers/1234567890'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "accepting_new_patients": true,
  • "address":
    {
    },
  • "bio": "Dr. Smith grew up in Newton, MA and graduated from Philadelphia College of Osteopathic Medicine. He completed his Residency program at Lehigh Valley Hospital ... ",
  • "conditions":
    [
    ],
  • "credential": "MD",
  • "doctor_reason": "I became a physician to inspire healthy living. The most rewarding ...",
  • "facilities":
    [
    ],
  • "fax": 1234567890,
  • "first_name": "John",
  • "gender": "M",
  • "hours_of_operation":
    [
    ],
  • "how_to_find": "The practice is located at the corner of Hampshire St and King Rd just off exit 30.",
  • "images":
    [],
  • "insurance_carriers":
    [
    ],
  • "languages":
    [
    ],
  • "last_name": "Smith",
  • "license_number": 2012057203,
  • "license_state": "NY",
  • "lgbtqia_friendly": true,
  • "lgbtqia_friendly_comment": "All patients are welcomed and respected",
  • "location":
    {
    },
  • "medicare": true,
  • "medicaid": true,
  • "middle_name": "C.",
  • "npi": 1234567890,
  • "patient_advice": "Let me know how your condition is affecting your quality of life, and ask me to review the non-surgical ...",
  • "philosophy": "We strive to build long-term, partnering relationships built on trust and mutual respect ...",
  • "phone": 1234567890,
  • "procedures":
    [
    ],
  • "profile_url": "https//www.caredash.com/doctors/john-smith-md-boston-ma",
  • "referral": true,
  • "short_summary": "Friendly, caring, punctual, Honest",
  • "specialties":
    [
    ],
  • "status": "available",
  • "summary": "Dr. John Smith, MD is a critical care surgery specialist in New London, NY.",
  • "transgender_safe_space": true,
  • "transgender_safe_space_comment": "All patients are welcomed and respected.",
}

Claim a provider

post /providers/{npi}
http://localhost:5001/v1/providers/{npi}
https://localhost:5001/v1/providers/{npi}

Claim a Provider in the CareDash database so that you can make edits to that provider's data.

Authorizations:
accessKey (provider:claim)
path Parameters
npi
required
integer

NPI of the provider

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful Provider claim

403

Permission denied

404

Provider not found

Request samples

Copy
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json'
--header 'Authorization: Bearer 1234'
'https://api.caredash.com/v1/providers/1234567890'

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "type": "OK",
  • "message": "Successful Provider claim for NPI {npi}"
}

Update a provider's data

patch /providers/{npi}
http://localhost:5001/v1/providers/{npi}
https://localhost:5001/v1/providers/{npi}

The PATCH request is used to modify a Provider already claimed by you. Any number of fields may be included in the request body. Fields not included in the request body are not affected and will retain their current values in the database.

If any fields in the payload fail validation, no updates will be processed. A response will be returned with a message describing the first of any validation failures encountered.

Passing a null value for a nullable field will remove the existing data in that field for the Provider.

  • If the field is a string field, a null value or an empty string may be passed to remove the existing data
  • If the field is an array field, a null value or an empty array may be passed to remove the existing data
Authorizations:
accessKey (provider:write)
path Parameters
npi
required
integer

NPI of the provider

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Request Body schema: application/json
accepting_new_patients
boolean (AcceptingNewPatients) Nullable

True if accepting new patients

address
object (RequestProviderAddress)

Address fields that will completely replace the address fields on the CareDash Provider. All fields except 'address_2' are required. If 'address_2' is not specified, the existing value for 'address_2' will be removed.

bio
string (ProviderBio) <= 2000 characters Nullable

A biography for the Provider

blog
string (Blog) Nullable

The full URL link to a related blog site

conditions
Array of string Nullable

A list of slugs identifying conditions treated by this provider. This will completely replace the existing list of conditions for the Provider. The allowed slugs can be found at /reference/conditions

doctor_reason
string (ProviderDoctorReason) <= 500 characters Nullable

A commentary on why the Provider entered healthcare.

facebook
string (Facebook) Nullable

The full URL link to a related Facebook page

fax
string (Fax) Nullable

10 digit fax number

first_name
string (ProviderFirstName)

The Provider's first name

gender
string (ProviderGender)
Enum:"M" "F"

Gender as 'M' or 'F'

hours_of_operation
Array of object (HoursOfOperation) Nullable

Hours open. There is a strict format required for this array of values. Expand the object at left to see details.

how_to_find
string (HowToFind) <= 1000 characters Nullable

Additional information on locating the address

images
Array of object (RequestProviderImages)

A list of image objects to add to a Provider. A Provider can have only one image of type 'profile'. If a 'profile' image exists for the Provider on CareDash already, it will be overwritten. Any 'gallery' images included in this list will be added to the existing gallery images. Finally, the images submitted here must not have the same 'url' as any existing images on the Provider (viewable via /providers/{id}).

instagram
string (Instagram) Nullable

The URL link to an Instagram account

insurance_carriers
Array of string Nullable

A list of slugs identifying insurance carriers accepted by this provider. This will completely replace the existing list of insurance carriers for the Provider. The allowed slugs can be found at /reference/insurance_carriers

languages
Array of string (RequestLanguages) Nullable

A list of languages. This list will completely replace any existing languages. The allowed languages can be found at /reference/languages

last_name
string (ProviderLastName)

The Provider's last name

linkedin
string (LinkedIn) Nullable

Full URL to an associated LinkedIn profile

lgbtqia_friendly
boolean (LGBTFriendly) Nullable

True if the services are LGBTQIA friendly

lgbtqia_friendly_comment
string (LGBTFriendlyComment) <= 100 characters Nullable

Additional comments regarding LGBTQIA friendly services

medicare
boolean (Medicare) Nullable

True if Medicaid is accepted

medicaid
boolean (Medicaid) Nullable

True if Medicare is accepted

middle_name
string (ProviderMiddleName) Nullable

The middle name of the Provider

patient_advice
string (ProviderPatientAdvice) <= 500 characters Nullable

The Provider's advice to patients before coming to see them

pinterest
string (Pinterest) Nullable

The URL link to a related Pinterest account

philosophy
string (ProviderPhilosophy) <= 500 characters Nullable

Commentary on the Provider's philosophy with regards to healthcare

phone
string (Phone)

10 digit phone number

referral
boolean (Referral) Nullable

True if referals are needed to make an appointment

scheduling_link
string (SchedulingLink) Nullable

The full URL to a page to schedule an appointment

short_summary
string (ProviderShortSummary) <= 75 characters Nullable

A short phrase that appears under the Provider name. Limited to 75 characters.

site_url
string (SiteURL) Nullable

The full URL to an associated website

snapchat
string (Snapchat) Nullable

The full URL to a related Snapchat account

specialties
Array of object (RequestProviderSpecialties)

A list of specialties objects for this Provider. This list will completely replace the existing specialties for the provider. Exactly one of the specialties in this list must be marked as the primary specialty. The list of allowed specialty slugs can be found with /reference/get_specialties

summary
string (ProviderSummary) <= 5000 characters Nullable

Summary text that appears in the 'About' section of the Provider's profile page

twitter
string (Twitter) Nullable

The full URL to a related twitter feed

transgender_safe_space
boolean (TransgenderSafeSpace) Nullable

True if the care is a transgender safe space

transgender_safe_space_comment
string (TransgenderSafeSpaceComment) <= 100 characters Nullable

Additional comments regarding transgender safe space

videos
Array of string (RequestVideos) Nullable

The full URLs to externally hosted videos. This list of URLs will completely replace any existing videos. The videos must be hosted on either Youtube or Vimeo.

Responses

200

Update successful

400

Bad request

403

Provider not claimed

404

Provider not found

Request samples

application/json
Copy
Expand all Collapse all
{
  • "accepting_new_patients": true,
  • "address":
    {
    },
  • "bio": "Dr. Smith grew up in Newton, MA and graduated from Philadelphia College of Osteopathic Medicine. He completed his Residency program at Lehigh Valley Hospital ... ",
  • "conditions":
    [
    ],
  • "doctor_reason": "I became a physician to inspire healthy living. The most rewarding ...",
  • "fax": 1234567890,
  • "first_name": "John",
  • "gender": "M",
  • "hours_of_operation":
    [
    ],
  • "how_to_find": "The practice is located at the corner of Hampshire St and King Rd just off exit 30.",
  • "images":
    [],
  • "insurance_carriers":
    [
    ],
  • "languages":
    [
    ],
  • "last_name": "Smith",
  • "lgbtqia_friendly": true,
  • "lgbtqia_friendly_comment": "All patients are welcomed and respected",
  • "medicare": true,
  • "medicaid": true,
  • "middle_name": "C.",
  • "patient_advice": "Let me know how your condition is affecting your quality of life, and ask me to review the non-surgical ...",
  • "philosophy": "We strive to build long-term, partnering relationships built on trust and mutual respect ...",
  • "phone": 1234567890,
  • "referral": true,
  • "short_summary": "Friendly, caring, punctual, Honest",
  • "specialties":
    [
    ],
  • "summary": "Dr. John Smith, MD is a critical care surgery specialist in New London, NY.",
  • "transgender_safe_space": true,
  • "transgender_safe_space_comment": "All patients are welcomed and respected.",
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "code": 200,
  • "type": "OK",
  • "message": "Successful update for Provider with NPI {npi}"
}

Remove a provider claim

delete /providers/{npi}
http://localhost:5001/v1/providers/{npi}
https://localhost:5001/v1/providers/{npi}

The DELETE request is used to remove a Provider from your control. You must supply the NPI of the provider in the path url.

Authorizations:
accessKey (provider:claim)
path Parameters
npi
required
integer

NPI of the provider

header Parameters
Authorization
required
string

Bearer {token} for a valid OAuth token.

Responses

200

Successful claim removal

403

Provider not claimed

404

Provider not found

Request samples

Copy
curl -X DELETE --header 'Accept: application/json'
--header 'Authorization: Bearer 1234'