Tross
ATHENA

Fetch patient vitals

Read date-filtered historical vitals from one Athena preview chart.

POSThttps://api.ontross.com/api/integrations/athena/fetch-patient-vitals
Request Fields
input.org_id
integer
required
Athena practice ID for the saved authentication.
Example
64200
input.department_id
integer
required
Department containing the patient's chart.
Example
12
input.patient_id
integer
required
Practice patient ID, not the chart or enterprise ID.
Example
842701
input.start_date
string
required
First included event date in YYYY-MM-DD format.
Example
"2026-03-01"
input.end_date
string
required
Last included event date in YYYY-MM-DD format; at most 366 days after start_date.
Example
"2026-03-31"
input.limit
integer
required
Maximum readings returned from the locally filtered response.
Example
1
input.offset
integer
Local offset; each request refetches the source, so pages are not a stable snapshot.
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
Practice patient ID used for this read.
Example
"842701"
chart_id
string
Resolved Athena chart ID.
Example
"920415"
start_date
string
First included event date requested by the caller.
Example
"2026-03-01"
end_date
string
Last included event date requested by the caller.
Example
"2026-03-31"
limit
integer
Local page size requested by the caller.
Example
1
offset
integer
Local offset requested by the caller.
Example
0
total_in_range
integer
Populated readings in the requested date range of this fetched response.
Example
2
has_more
boolean
Whether this fetched response has readings after the returned slice.
Example
true
next_offset
integer
Next offset
readings
array
Readings in this local page, newest event date first.
readings[].source_id
string
Identifier of this reading in Athena's historical-vitals response.
Example
"570131"
readings[].clinical_element_id
string
Athena clinical element identifying the measurement type.
Example
"VITALS.HEARTRATE"
readings[].name
string
Name
readings[].group_key
string
Source vital group containing the reading.
Example
"VITALS"
readings[].value
string
Populated measurement value as returned by Athena.
Example
"72"
readings[].unit
string
Unit
readings[].event_date
string
Measurement event date in YYYY-MM-DD format; no time is inferred.
Example
"2026-03-10"
readings[].created_at
string
Created at
readings[].event_key
string
Source key linking the reading to its flowsheet set.
Example
"FLOWSHEET:78100:0"
readings[].reading_id
string
Reading-set identifier within the source flowsheet.
Example
"0"
readings[].source_container_id
string
Source flowsheet container identifier.
Example
"78100"
readings[].source_type
string
Source type; currently FLOWSHEET for this operation.
Example
"FLOWSHEET"
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena/fetch-patient-vitals \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"department_id":12,"end_date":"2026-03-31","limit":1,"offset":0,"org_id":64200,"patient_id":842701,"start_date":"2026-03-01"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "department_id": 12,
    "end_date": "2026-03-31",
    "limit": 1,
    "offset": 0,
    "org_id": 64200,
    "patient_id": 842701,
    "start_date": "2026-03-01"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "chart_id": "920415",
    "end_date": "2026-03-31",
    "has_more": true,
    "limit": 1,
    "next_offset": 1,
    "offset": 0,
    "patient_id": "842701",
    "readings": [
      {
        "clinical_element_id": "VITALS.HEARTRATE",
        "event_date": "2026-03-10",
        "event_key": "FLOWSHEET:78100:0",
        "group_key": "VITALS",
        "name": "Heart rate",
        "reading_id": "0",
        "source_container_id": "78100",
        "source_id": "570131",
        "source_type": "FLOWSHEET",
        "value": "72"
      }
    ],
    "start_date": "2026-03-01",
    "total_in_range": 2
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}