Getting a Provider's Profile
After searching for available providers for a patient, the profile details for any provider selected by the patient are available. The profile will include details about the provider as well as the provider’s latest scheduling availability information as it relates to the patient’s preferred appointment.
This request must include a valid JWT token, please see our documentation
HTTP Request
Section titled “HTTP Request”GET {server_url}/api/v2/providers/{provider_id}/profile
Header Parameter
Section titled “Header Parameter”| Parameter | Default | Description |
|---|---|---|
| Content-type | application/json | Expected content type, currently only JSON is supported |
| Authorization | Bearer {TOKEN} | Auth Token, should be the string “Bearer {TOKEN}” |
URL Parameter
Section titled “URL Parameter”| Attribute | Required | Description |
|---|---|---|
| provider_id | true | MD Live ID for provider |
Query String Parameters
Section titled “Query String Parameters”| Attribute | Required | Description |
|---|---|---|
| provider_type | true | Provider Type ID, from the provider types list (or the endpoint response). Use to specify the preferred doctor type for an appointment. |
| patient_id | false | MD Live ID for patient scheduling a visit, use to specify patient only if the token provided is an API token instead of a User token |
| availability_type | false | Can be either ‘phone’ or ‘video’, use to specify the preferred type of appointment for the patient |
| specific_date | false | Date in YYYY-mm-dd format, use to specify a preferred date for an appointment. Default is today. |
| show_next_availability | false | Can be either true or false. Default is true. When true, if specific_date is ‘today’ and the provider does not have any hours available, the available_hours array will contain information for the date the provider is next available. When false, if specific_date is ‘today’ and the provider does not have any hours available, available_hours will be an empty array. |
| state_abbrev | false | Abbreviation of U.S. state, use to specify the preferred state for the appointment. Default is the patient’s MD Live address. |
Example Request
Section titled “Example Request”curl {server_url}/api/v2/providers/{provider_id}/profile?provider_type={provider_type}-H "Content-type: application/json"-H "Authorization: Bearer 34a2sample-user-token"RestClient::Request.new( :method => :get, :url => "{server_url}/api/v2/providers/{provider_id}/profile}?provider_type={provider_type}", :headers => { "Content-type" => "application/json", "Authorization" => "Bearer 34a2sample-user-token" }).executeExample Response
Section titled “Example Response”{ "provider_details": { "id": 4, "fullname": "Travis Stork", "gender": "Male", "city": "MIAMI BEACH", "state_abbrev": "FL", "phone": "3057997818", "photo_url": "/users/4/photo", "photo_url_absolute": "https://patient.mdlive.com/assets/default-profile-picture.png", "years_in_practice": 15, "education": "Certified Nurse Educator", "about_me": "This is my profile description", "licenses": [ { "state_id": 10, "state": "Florida" }, { "state_id": 44, "state": "Texas" }, { "state_id": 11, "state": "Georgia" } ], "languages": [ { "id": 1, "name": "English", "alpha3_code": "eng" }, { "id": 7, "name": "Polish", "alpha3_code": "pol" } ], "specialties": [ { "id": 1, "name": "Abdominal Surgery", "code": "AS" }, { "id": 51, "name": "General Practice", "code": "GP" } ], "publications": "Over 15 peer review publications in the field of emergency medicine and disaster medicine" }, "availability_details": { "available_hours": [ { "timeslot": "2018-01-10T15:00:00.000-05:00", "phys_availability_id": 6096481, "availability_type": [ "video" ] }, { "timeslot": "2018-01-10T15:30:00.000-05:00", "phys_availability_id": 6097008, "availability_type": [ "phone" ] } ], "is_visit_now_available": false, "can_request_appointment": true, "appointment_date": "2018-01-15", "patient_appointment_types": [ "video", "phone" ] }}