Tross
ATHENA PROD

Fetch patient appointments

Get a patient's appointment history.

POSThttps://api.ontross.com/api/integrations/athena-prod/fetch-patient-appointments
Request Fields
input.org_id
integer
required
Athena practice ID.
Example
32817
input.department_id
integer
required
Chart department ID.
Example
1
input.patient_id
integer
required
Practice patient ID.
Example
1133
input.include_cpt_codes
boolean
Also read the patient's claims and attach each appointment's billed CPT/HCPCS charge lines (cpt_codes). One claim read per claim on the patient.
Example
true
Default
false
input.limit
integer
Maximum appointments returned from one bounded source response.
Example
25
Default
25
input.offset
integer
Local offset; pages refetch the source.
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
patient_id
string
Requested practice patient ID.
Example
"1133"
appointments
array
Appointment history rows in Athena's own order.
appointments[].appointment_id
string
Appointment ID, from the history row's link.
Example
"385543"
appointments[].date
string
Appointment date as the history table shows it.
Example
"October 16, 2026"
appointments[].time
string
Appointment time as the history table shows it.
Example
"09:20 AM"
appointments[].sort_value
string
Athena's sortable date for the row.
Example
"20261016"
appointments[].status
string
Appointment status label.
Example
"checked in"
appointments[].status_code
string
Athena's short status code shown beside the label.
Example
"2"
appointments[].status_detail
string
Athena's sort value for the status column.
Example
"2"
appointments[].department
string
Department the appointment sits in.
Example
"Main Street Clinic"
appointments[].provider
string
Provider the appointment is booked with.
Example
"ASHLEE_LEWIS_OH"
appointments[].appointment_type
string
Appointment type.
Example
"Case Management 15"
appointments[].duration
string
Scheduled duration, as the type cell reports it.
Example
"20 min"
appointments[].notes
array
Scheduling notes recorded on the appointment.
appointments[].notifications
array
Notification lines Athena lists under the appointment.
appointments[].procedures
array
Procedure lines recorded against the appointment (date, description, provider). The history page carries no codes; ask for include_cpt_codes to get them from the claim.
appointments[].procedures[].date
string
Date of the procedure line as Athena shows it.
Example
"10/16/2026"
appointments[].procedures[].description
string
Procedure description. This is Athena's own text, not a CPT code.
Example
"OFFICE/OUTPATIENT VISIT EST"
appointments[].procedures[].provider
string
Provider username on the line.
Example
"ASHLEE_LEWIS_OH"
appointments[].procedures[].raw
string
The line exactly as rendered, for anything the split missed.
Example
"10/16/2026 OFFICE/OUTPATIENT VISIT EST, ASHLEE_LEWIS_OH"
appointments[].claim_id
string
Claim created from this appointment (only with include_cpt_codes).
Example
"93469"
appointments[].cpt_codes
array
Billed CPT/HCPCS charge lines from the appointment's claim (only with include_cpt_codes).
appointments[].cpt_codes[].claim_id
string
Claim the charge line belongs to.
Example
"93469"
appointments[].cpt_codes[].service_date
string
Service date of the charge (YYYY-MM-DD).
Example
"2025-07-31"
appointments[].cpt_codes[].procedure_code
string
CPT / HCPCS code billed.
Example
"G0439"
appointments[].cpt_codes[].description
string
Athena's description of the code.
Example
"ANNUAL WELLNESS EXAM SUBSEQUENT"
appointments[].cpt_codes[].modifiers
array
Charge modifiers.
Example
["25"]
appointments[].cpt_codes[].units
string
Units billed.
Example
"1"
total_matching
integer
Appointments in the history before paging.
Example
1
limit
integer
Requested page size.
Example
25
offset
integer
Requested offset.
Example
0
has_more
boolean
Whether more appointments follow this page.
Example
false
next_offset
integer
Offset of the next page, when one exists.
Example
25
Code
curl curl %s %s POST \
  --url https://api.ontross.com/api/integrations/athena-prod/fetch-patient-appointments \
  %s %s 'X-API-Key: REPLACE_KEY_VALUE' \
  %s %s 'content-type: application/json' \
  %s %s '{"input":{"department_id":1,"limit":25,"offset":0,"org_id":32817,"patient_id":1133},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "department_id": 1,
    "limit": 25,
    "offset": 0,
    "org_id": 32817,
    "patient_id": 1133
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "patient_id": "1133",
    "appointments": [
      {
        "appointment_id": "385543",
        "date": "October 16, 2026",
        "time": "09:20 AM",
        "sort_value": "20261016",
        "status": "checked in",
        "status_code": "2",
        "status_detail": "2",
        "department": "Main Street Clinic",
        "provider": "ASHLEE_LEWIS_OH",
        "appointment_type": "Case Management 15",
        "duration": "20 min",
        "notes": [
          "string"
        ],
        "notifications": [
          "string"
        ],
        "procedures": [
          {
            "date": "10/16/2026",
            "description": "OFFICE/OUTPATIENT VISIT EST",
            "provider": "ASHLEE_LEWIS_OH",
            "raw": "10/16/2026 OFFICE/OUTPATIENT VISIT EST, ASHLEE_LEWIS_OH"
          }
        ],
        "claim_id": "93469",
        "cpt_codes": [
          {
            "claim_id": "93469",
            "service_date": "2025-07-31",
            "procedure_code": "G0439",
            "description": "ANNUAL WELLNESS EXAM SUBSEQUENT",
            "modifiers": [
              "25"
            ],
            "units": "1"
          }
        ]
      }
    ],
    "total_matching": 1,
    "limit": 25,
    "offset": 0,
    "has_more": false,
    "next_offset": 25
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}