Find
/v3/patient/find endpoint reference.
URL: https://demo.1health.io/api/v3/patient/find
No description available in the API specification.
Endpoints
| Endpoint | Method | Description |
|---|---|---|
| /v3/patient/find | GET | Find patients matching demographic criteria |
GET/v3/patient/find
Find patients matching demographic criteria
Overview
Looks up patients by demographic criteria and returns a ranked list of candidates, each with a confidence score. Use it before creating a patient to check whether the person already exists, or any time you need to resolve a person to a patient ID. This operation is read-only and never creates or modifies a patient.
Authorization
Bearer JWT required. See the authentication guide.
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| firstName | String | No | Given name to match. | |
| lastName | String | No | Family name to match. | |
| dob | String | No | Date of birth in YYYY-MM-DD format. | |
| sexAtBirth | String | No | Biological sex at birth. Non-discriminating when omitted or unknown. | |
| exact | boolean | No | false | When true, returns only exact matches (score 1.0). Defaults to false (fuzzy matching). |
Responses
200 OK
Ranked list of matching patients (possibly empty).
DTO: PatientFindResponseDTO
{
"patients": [
{}
]
}
| Field | Type | Nullable | Description |
|---|---|---|---|
| patients | List | Yes | The matching patient candidates. Empty when no patient meets the criteria. |
400 Bad Request
Invalid request. Possible causes: • No demographic criteria provided (firstName, lastName, dob, or sexAtBirth) • Invalid sexAtBirth value • Invalid date format for dob
401 Unauthorized
Not authenticated — valid session required.
Example
curl -X GET "https://demo.1health.io/api/v3/patient/find" \
-H "Authorization: Bearer $TOKEN"
Navigation
Parent: https://agents.1health.io/public/demo/api/v3/patient/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md