Tross
ECLINICALWORKS

Search patients

Search the practice's patients by name.

POSThttps://api.ontross.com/api/integrations/ecw/search-patients
Request Fields
input.query
string
Single-box name search. 'Last, First' is split; a bare term is matched as a surname. Use first_name/last_name instead when you have them separately.
Example
"Example, Jordan"
input.first_name
string
Patient's given name.
Example
"Jordan"
input.last_name
string
Patient's family name.
Example
"Example"
input.dob
string
Date of birth in MM/DD/YYYY, the field eCW matches on to separate patients sharing a name.
Example
"01/01/1980"
input.mrn
string
Medical record number.
Example
"900001"
input.phone
string
Any phone number on the chart.
Example
"555-0100"
input.active_only
boolean
Restrict to active charts, as eCW's Find box does by default.
Example
true
Default
true
input.limit
integer
Maximum rows, 1 to 200, defaulting to 50.
Example
25
Default
50
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
query
string
Text matched against patient names.
Example
"test"
total_count
integer
Total matches eCW reports, which can exceed the returned list.
Example
38
count
integer
Number of patient search hits included in this response.
Example
25
patients
array
Search hits, each keeping the raw eCW fields too.
patients[].id
string
Patient chart identifier usable for subsequent patient operations, from fetch-patients.
Example
"407069"
patients[].name
string
Chart owner's display label, typically Last, First.
Example
"Example, Jordan"
patients[].dob
string
Recorded birth date as eCW formats it.
Example
"04/12/1985"
patients[].sex
string
Sex as the patient's chart records it.
Example
"Female"
Code
curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/ecw/search-patients \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"query":"Example, Jordan","first_name":"Jordan","last_name":"Example","dob":"01/01/1980","mrn":"900001","phone":"555-0100","active_only":true,"limit":25},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "query": "Example, Jordan",
    "first_name": "Jordan",
    "last_name": "Example",
    "dob": "01/01/1980",
    "mrn": "900001",
    "phone": "555-0100",
    "active_only": true,
    "limit": 25
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "query": "test",
    "total_count": 38,
    "count": 25,
    "patients": [
      {
        "id": "407069",
        "name": "Example, Jordan",
        "dob": "04/12/1985",
        "sex": "Female"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}