Search by patients returning a PatientStudio object

get

https://api.talkdeskapp.com/healthcare/patients-studio

Search by patients returning one PatientStudio object only. If the search result returns a number of patients different from one, a PatientStudio object is returned with its count property pointing to the number of results found.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

hls-patient:read

Query Params

interaction_id

string

required

length between 1 and 2147483647

Required interaction Id

first_name

string

length between 1 and 2147483647

Patient's first name

last_name

string

length between 1 and 2147483647

Patient's last name

ssn

string

length between 1 and 2147483647

Patient's social security number

lookup_information

string

length between 1 and 2147483647

The information to be used to search for the patient. It must be present if the lookup_information_type is present.

lookup_information_type

string

enum

length between 1 and 2147483647

The information type to be used to search for the patient. It must be present if the lookup_information is present.

Allowed:

mrn

string

length between 1 and 2147483647

Patient's medical record number

birth_date

string

length between 1 and 2147483647

Birth date

gender

string

enum

Gender

Allowed:

phone_number

string

length between 1 and 15

Patient's phone number

get_pcp_info

boolean

Optional flag to get the full information of the primary care provider(s) (PCP) linked to a patient. Defaults to false.

timezone

string

length between 1 and 2147483647

Timezone from this interaction and must respect this format US/Eastern.

zipcode

string

The zipcode of the patient's home address

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

405Method Not Allowed

415Unsupported Media Type