Tross
Demo dataBook a demo
ELATION

Get patient appointments

Get past and future patient appointments.

POSThttps://preview.ontross.com/api/integrations/elation/get-patient-appointments
Request Fields
input.patient_id
string
required
Patient whose chart is read or written, from search-patients.
Example
"350949464068019"
input.limit
integer
Maximum rows, 1 to 200, defaulting to 50 or 100.
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
patient_id
string
Patient whose chart is read or written, from search-patients.
Example
"350949464068019"
past_count
integer
Total past appointments Elation reports, which can exceed the list.
Example
1
past
array
The patient's past appointments, newest first.
past[].id
string
Scheduled visit identifier from the patient's appointment feed.
Example
"0503006490461366"
past[].appt_time
string
Appointment start stamped MM/DD/YYYY HH:MM:SS with a UTC offset.
Example
"Example text."
past[].status
string
Display state, falling back to the underlying appointment state.
Example
"Example"
past[].provider_id
string
Physician user id, the user_id field from list-physicians, not id.
Example
"306223"
past[].provider_name
string
Physician display name in Last,First form, resolved to a user id.
Example
"Rivera, Alex"
past[].appt_type
string
Appointment type label as the patient's chart shows it.
Example
"Example text."
past[].visit_note_id
string
Visit note attached to the appointment, empty when none.
Example
"999000000000701"
future
array
The patient's upcoming appointments as Elation ordered them.
future[].id
string
Scheduled visit identifier from the patient's appointment feed.
Example
"0503006490461366"
future[].appt_time
string
Appointment start stamped MM/DD/YYYY HH:MM:SS with a UTC offset.
Example
"Example text."
future[].status
string
Display state, falling back to the underlying appointment state.
Example
"Example"
future[].provider_id
string
Physician user id, the user_id field from list-physicians, not id.
Example
"306223"
future[].provider_name
string
Physician display name in Last,First form, resolved to a user id.
Example
"Rivera, Alex"
future[].appt_type
string
Appointment type label as the patient's chart shows it.
Example
"Example text."
future[].visit_note_id
string
Visit note attached to the appointment, empty when none.
Example
"999000000000701"
latest_past_provider_id
string
Provider on the most recent past appointment, the review target.
Example
"306223"
latest_past_provider_name
string
Name of the provider on the most recent past appointment.
Example
"Rivera, Alex"
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/elation/get-patient-appointments \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"patient_id":"350949464068019","limit":25},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "patient_id": "350949464068019",
    "limit": 25
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient_id": "350949464068019",
    "past_count": 1,
    "past": [
      {
        "id": "0503006490461366",
        "appt_time": "01/08/2026 09:30:00 -0600",
        "status": "Completed",
        "provider_id": "999000000000201",
        "provider_name": "Dana Whitfield",
        "appt_type": "Follow-up",
        "visit_note_id": "999000000000701"
      }
    ],
    "future": [
      {
        "id": "0503006490461366",
        "appt_time": "01/08/2026 09:30:00 -0600",
        "status": "Completed",
        "provider_id": "999000000000201",
        "provider_name": "Dana Whitfield",
        "appt_type": "Follow-up",
        "visit_note_id": "999000000000701"
      }
    ],
    "latest_past_provider_id": "999000000000201",
    "latest_past_provider_name": "Dana Whitfield"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}