Elation Search patients

POSThttps://preview.ontross.com/api/integrations/elation/search-patients

input.query

string

required

Patient name to search for

Example

"example"

input.limit

integer

Maximum rows, 1 to 200, defaulting to 50 or 100.

Example

5

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"

query

string

Text matched against patient names or document tag values.

Example

"example"

total_count

integer

Total local matches Elation reports, which can exceed the list.

Example

0

count

integer

Number of patient search hits included in this response.

Example

0

patients

array

Search hits, each keeping the raw Elation fields too.

patients[].id

string

Chart owner identifier usable for subsequent patient operations.

Example

"999000000000101"

patients[].name

string

Chart owner's display label, typically LAST, FIRST.

Example

"TESTPATIENT, AVERY"

patients[].dob

string

Recorded birth date formatted as MM/DD/YYYY.

Example

"04/17/1968"

patients[].sex

string

Sex as the patient's chart records it.

Example

"Female"

patients[].age

string

Reported years of life represented as text.

Example

"57"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/elation/search-patients \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"query":"example","limit":5},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "query": "example",
    "limit": 5
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "query": "example",
    "total_count": 0,
    "count": 0,
    "patients": [
      {
        "id": "999000000000101",
        "name": "TESTPATIENT, AVERY",
        "dob": "04/17/1968",
        "sex": "Female",
        "age": "57"
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}