Searching for Providers

For medical appointments, you can schedule a visit with an available provider or see the first available doctor. To view a paginated list of available providers for a patient, make a request to:

This request must include a valid User JWT token, please see our documentation

HTTP Request

POST {server_url}/api/v2/patients/{patient_id}/providers/search

Header Parameter

Parameter	Default
Content-type	application/json
Accept	application/json
Authorization	Bearer {jwttoken}

URL Parameter

Attribute	Required	Description
patient_id	true	MD Live ID for patient
per_page	false	# of providers per page
page	false	Page #

Note

When the page and per_page parameters are not specified, the api defaults to the first 20 results.

Request Body Parameters

Attribute	Type	Required	Description
search_params	object	true	Object with specific search filters
↳  state_abbrev	string	true	2 Letter state abbreviated, from the states list
↳  availability_type	array of strings	false	Can be either ['phone'], ['video'], or ['phone', 'video']. Use to specify the preferred type of appointment for the patient
↳  gender	string	false	Preferred provider gender (Male or Female)
↳  provider_type_id	integer	false	Provider Type ID, from the provider types list (or the endpoint response)
↳  specific_date	string	false	Date in YYYY-mm-dd format
↳  language_id	integer	false	Language ID from the languages list (See Languages)

Tip

is_visit_now_available in provider search response is true when the provider is available for an immediate consultation

Example Request

Shell

curl -X POST {server_url}/api/v2/patients/{patient_id}/providers/search
  -H "Content-type: application/json"
  -H "Authorization: Bearer 34a2sample-user-token"
  -H "Accept: application/json"
  -d '{ "search": {
           "state_abbrev": "FL",
           "language_id": 1
         }
      }'

Ruby

RestClient::Request.new(
  method: :post,
  url: "#{server_url}/api/v2/patients/#{patient_id}/providers/search",
  headers: {
    "Content-type" => "application/json",
    "Authorization" => "Bearer 34a2sample-user-token"
    "Accept" => "application/json"
  },
  payload: {
    search: {state_abbrev: "FL", language_id: 1}
  }
).execute

Example Response

{
  "providers": [
    {
      "id": 542127369,
      "fullname": "Dr. Keylime Pie",
      "gender": "Female",
      "photo_url": null,
      "photo_url_absolute": "https://patient.mdlive.com/assets/default-profile-picture.png",
      "specialty": "General Practice",
      "group_name": null,
      "is_visit_now_available": false,
      "status": "Available",
      "next_appt_available_date": "2017-11-09T13:45:00-05:00",
      "availability_type": null
    },
    {
      "id": 542114314,
      "fullname": "Dr. Test Amalie",
      "gender": "Male",
      "photo_url": null,
      "photo_url_absolute": "https://patient.mdlive.com/assets/default-profile-picture.png",
      "specialty": "General Practice",
      "group_name": null,
      "is_visit_now_available": false,
      "status": "Available",
      "next_appt_available_date": "2017-11-09T13:45:00-05:00",
      "availability_type": null
    },
    {
      "id": 542117784,
      "fullname": "Dr. Andy Available",
      "gender": "Male",
      "photo_url": null,
      "photo_url_absolute": "https://patient.mdlive.com/assets/default-profile-picture.png",
      "specialty": "General Practice",
      "group_name": null,
      "is_visit_now_available": false,
      "status": "Available",
      "next_appt_available_date": "2017-11-09T13:45:00-05:00",
      "availability_type": null
    }
  ],
  "refine_search_options": {
    "default_provider_types": [
      {
        "id": 3,
        "name": "Family Physician"
      },
      {
        "id": 5,
        "name": "Therapist"
      },
      {
        "id": 6,
        "name": "Psychiatrist"
      },
      {
        "id": 12,
        "name": "Dermatologist"
      }
    ],
    "availability_type": [
      "phone",
      "video"
    ]
  }
}