v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Patient Registration API

Search Patient profiles by mobile number

This API provides functionality to get all profiles of patient by their mobile number in business' directory.

<Note> This API only works on 10 digit mobile number and cannot be used for searching partial phone numbers. The patient with given mobile number should already be registered with business account for results to show up. </Note>

Request Parameter

Parameter	Type	Expected Values	Description	Required/Optional/Not Required
mobile	string	10 digit phone number	Patient's mobile number	Required

Response parameter

Parameter	Type	Expected Values	Description
data	object		Response data object
data.profiles	array		List of patient profiles
data.profiles[].name	string	"Amit Kumar"	Patient's full name
data.profiles[].patient_id	string	"123456789012345"	Unique identifier for the patient (can be null)
data.profiles[].patient_profile	object		Detailed patient profile information
data.profiles[].patient_profile.created_at	string	"2024-08-13T07:31:53.750Z"	Timestamp of profile creation
data.profiles[].patient_profile.dob	string	"1990-05-15"	Patient's date of birth
data.profiles[].patient_profile.first_name	string	"Amit"	Patient's first name
data.profiles[].patient_profile.middle_name	string	""	Patient's middle name (can be empty)
data.profiles[].patient_profile.last_name	string	"Kumar"	Patient's last name
data.profiles[].patient_profile.gender	string	"M" / "F" / "O"	Patient's gender
data.profiles[].patient_profile.mobile	string	"+919876543210"	Patient's mobile number
data.profiles[].patient_profile.patient_id	string \| null	"123456789012345"	Unique identifier for the patient (can be null)
status_code	integer	200	HTTP status code of the response
success	boolean	true	Indicates if the request was successful

Status Codes

• 200: Success

• 403: Patient/Business data missing

• 500: Wrong API URL/Wrong JSON request/ Something went wrong

get/dr/v1/business/patients/search

Query parameters

mobilestring required

Example:<mobile_no>

Headers

authstring required

The auth token of the user. It is used to authenticate the user.

Response

Example response

{
  "data": {
    "profiles": [
      {
        "name": "Amit Kumar",
        "patient_id": "987654321098722",
        "patient_profile": {
          "patient_id": "987654321098722",
          "first_name": "Amit",
          "middle_name": "",
          "last_name": "Kumar",
          "dob": "1990-05-15",
          "gender": "M",
          "mobile": "+919876543210",
          "created_at": "2024-08-13T07:31:53.750Z"
        }
      },
      {
        "name": "Priya Sharma",
        "patient_id": "98765432109222",
        "patient_profile": {
          "patient_id": "987654321098722",
          "first_name": "Priya",
          "middle_name": "",
          "last_name": "Sharma",
          "dob": "1985-09-20",
          "gender": "F",
          "mobile": "+918765432109",
          "created_at": "2023-10-26T06:20:36.758Z"
        }
      },
      {
        "name": "Rahul Gupta",
        "patient_id": "987654321098765",
        "patient_profile": {
          "patient_id": "987654321098765",
          "first_name": "Rahul",
          "middle_name": "",
          "last_name": "Gupta",
          "dob": "1978-11-30",
          "gender": "M",
          "mobile": "+917654321098",
          "created_at": "2024-08-14T09:01:14.806Z"
        }
      }
    ]
  },
  "status_code": 200,
  "success": true
}