Provider Search

Base Path: /actor/current/webmail/DIRECT/mailboxes/{mailboxAddress}/providers/search

Version: 3.5.0

The Provider Search API can search for the Direct email addresses of healthcare workers (providers) based on the criteria you provide.

Authorization: OAuth 2.0 Bearer token is required to access the resources of this API. Once signed up, credentials and URL to access the OAuth API can be found on My Apps Page.

Methods

Find provider (advanced search)

POST /actor/current/webmail/DIRECT/mailboxes/{mailboxAddress}/providers/search/

Finds the Direct email addresses of providers based on the specified criteria.

Parameters

Name

Type

Data Type

Description

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload: 

{
  "criteria": "example",
  "specialty": "",
  "facility": "",
  "location": "",
  "organization": "",
  "maxResults": 10
}


Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.


Sample Value: developer.portal@example.com

Responses

application/json+fhir

200

Successfully found providers.

application/json+fhir

401

Your API key or access token has expired or is invalid.

Sample Request

curl -X POST "https://api.orionhealth.io/actor/current/webmail/DIRECT/mailboxes/developer.portal@example.com/providers/search/" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>' \
-H 'Content-Type: application/json' \
-d '{"criteria":"example","specialty":"","facility":"","location":"","organization":"","maxResults":10}'