Tross
Demo dataBook a demo
ATHENA

Fetch encounters patient

Get a patient's appointment history.

POSThttps://preview.ontross.com/api/integrations/athena/fetch-encounters-patient
Request Fields
input.patient_id
string
required
Patient whose chart is read or written, from the chart URL.
Example
4044
input.org_id
string
required
Practice context, shown in the athenanet portal URL.
Example
47902
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
appointments
array
Booked appointments, or scraped history table rows for the patient operation.
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena/fetch-encounters-patient \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":4044,"org_id":47902},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": 4044,
    "org_id": 47902
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "appointments": [
      {}
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}