Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Patient

Search patient profiles

Global Search is exclusive to specific workspaces only. Please reach out to support.

Search patient profiles by username, mobile, or full name (prefix match).

The limit parameter controls the number of results fetched internally (default: 50, maximum: 50).

get/profiles/v1/patient/search

Query parameters

prefixstring required
Example:121

The search term to match against patient profiles. This can be a username, mobile number, or full name (prefix match).

limitinteger
Example:10
selectstring

Comma-separated list of additional fields to include in the response. Example: abha,dob,gen

Valid optional fields: abha, c_ate, dob, gen, u_ate, is_age

Headers

client-idstring required
Example:EC_1431

Response

A list of patient profiles matching search query (PREfix search)

usernamestring
mobilestring
oidstring
flnstring

Example response

[
  {
    "username": "1111111111",
    "mobile": "98765XXXXX",
    "oid": "17552615662165",
    "fln": "Veena"
  }
]