Get Patient

/api/v1/patient

Bot MD will fetch patient information based on the provided search criteria. Bot MD will use this endpoint to look up existing patients by their date of birth, name, email, phone number, or national ID.

Authentication

HTTP Basic Auth

Query Parameters

Parameter	Type	Required	Description
name	string	Required	Full name of the patient.
dob	string	Required	Date of birth of the patient (YYYY-MM-DD format).
phone	string	Required	Phone number of the patient.
email	string	Optional	Email address of the patient.
nationalId	string	Optional	National ID or identification number of the patient.

Response Fields

Field	Type	Description
patientId	string	Unique ID of the patient record.
name	string	Full name of the patient.
email	string	Email address of the patient.
phone	string	Phone number of the patient.
dob	string	Date of birth of the patient.
nationalId	string	National ID or identification number of the patient.

Examples

Example RequestcURL

curl -u PROVIDER_USER_ID:PROVIDER_API_KEY \
  "https://api.provider.example/v1/patient?name=Jane%20Doe&dob=1990-05-15&phone=%2B6591234567"

Example RequestJavaScript

const response = await fetch('https://api.provider.example/v1/patient?name=Jane%20Doe&dob=1990-05-15&phone=%2B6591234567', {
  method: 'GET',
  headers: {
    'Authorization': 'Basic ' + btoa(USER_ID + ':' + API_KEY)
  }
});
const data = await response.json();

Response Example

ResponseJSON

{
  "patientId": "1001",
  "name": "Jane Doe",
  "email": "[email protected]",
  "phone": "+6591234567",
  "dob": "1990-05-15",
  "nationalId": "S1234567A"
}