Tross
ATHENA PROD

Search patients

Search one Athena patient list by name and optional date of birth.

POSThttps://api.ontross.com/api/integrations/athena-prod/search-patients
Request Fields
input.org_id
integer
required
Athena practice ID for the saved authentication.
Example
64200
input.department_id
integer
required
Athena department ID within the practice.
Example
12
input.name
string
required
Name filter sent to Athena. Matching and uniqueness are determined by Athena.
Example
"Ellis"
input.limit
integer
required
Maximum number of matches returned from this response; not an upstream search limit.
Example
1
input.dob
string
Dob
Example
"2026-01-01"
input.offset
integer
Local offset within one fetched response. Each call refetches, so pages are not a stable snapshot.
Example
0
Default
0
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
patients
array
Matches in Athena's order for this local slice.
patients[].patient_id
string
Practice patient ID (not chart or enterprise ID).
Example
"842701"
patients[].first_name
string
First name returned by Athena.
Example
"Morgan"
patients[].last_name
string
Last name returned by Athena.
Example
"Ellis"
patients[].dob
string
Dob
result_count
integer
Number of matches in this returned slice, not the total search population.
Example
1
limit
integer
Local result cap requested by the caller.
Example
1
offset
integer
Local offset requested by the caller.
Example
0
has_more
boolean
More rows exist in this response after the local slice; independent of upstream truncation.
Example
true
next_offset
integer
Next offset
upstream_truncated
boolean
Athena Boolean(MAXRESULTS). False is not an exhaustive-result guarantee.
Example
false
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena-prod/search-patients \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"department_id":12,"limit":1,"name":"Ellis","offset":0,"org_id":64200},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "department_id": 12,
    "limit": 1,
    "name": "Ellis",
    "offset": 0,
    "org_id": 64200
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "has_more": true,
    "limit": 1,
    "next_offset": 1,
    "offset": 0,
    "patients": [
      {
        "dob": "1987-04-18",
        "first_name": "Morgan",
        "last_name": "Ellis",
        "patient_id": "842701"
      }
    ],
    "result_count": 1,
    "upstream_truncated": false
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}