Athena Fetch patient open orders

POSThttps://preview.ontross.com/api/integrations/athena/fetch-patient-open-orders

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.limit

integer

required

Maximum matching open orders returned from this source response.

Example

1

input.order_id

string

Optional exact source order ID as a numeric string.

Example

"74821"

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"

patient_id

string

Practice patient ID used for this read.

Example

"842701"

chart_id

string

Resolved Athena chart ID.

Example

"920415"

order_id

string

Exact source order ID filter requested by the caller, or null.

Example

"74821"

limit

integer

Local page size requested by the caller.

Example

1

offset

integer

Local offset requested by the caller.

Example

0

total_matching

integer

Open orders matching the optional ID filter before local paging.

Example

2

has_more

boolean

Whether this fetched response has matching orders after the returned slice.

Example

true

next_offset

integer

Next local offset when has_more is true; otherwise null.

Example

1

orders

array

Open orders in this local page; no result data is included.

orders[].source_id

string

Identifier of the open order in Athena.

Example

"74821"

orders[].source_status

string

Order status exactly as supplied by Athena; this operation reads open orders only.

Example

"REVIEW"

orders[].display_name

string

Order name displayed in the chart.

Example

"Lipid panel"

orders[].description

string

Additional source order description, when supplied.

Example

"Lipid panel, serum"

orders[].order_type_id

string

Athena clinical order type identifier, when supplied.

Example

"421"

orders[].order_type_name

string

Athena clinical order type name, when supplied.

Example

"Lipid panel"

orders[].code

string

Clinical order type code, when supplied.

Example

"24331-1"

orders[].code_set

string

Coding system for the clinical order type code.

Example

"LOINC"

orders[].code_description

string

Description of the clinical order type code.

Example

"Lipid panel - Serum or Plasma"

orders[].provider_order_type_id

string

Provider-specific order type identifier, when supplied.

Example

"482"

orders[].provider_order_type_name

string

Provider-specific order type name, when supplied.

Example

"Lipid panel"

orders[].provider_loinc

string

Provider order type LOINC code, when supplied.

Example

"24331-1"

orders[].electronic_order_code

string

Electronic order code, when supplied.

Example

"LP-100"

orders[].order_date

string

Source order date or timestamp, when supplied.

Example

"2026-03-10T11:20:00-04:00"

orders[].encounter_date

string

Associated encounter date or timestamp, when supplied.

Example

"2026-03-10"

orders[].created_at

string

Source creation date or timestamp, when supplied.

Example

"2026-03-10T11:20:00-04:00"

orders[].approved_at

string

Source approval date or timestamp, when supplied.

Example

"2026-03-10T12:00:00-04:00"

orders[].encounter_id

string

Associated encounter identifier, when supplied.

Example

"42018"

orders[].created_encounter_id

string

Encounter identifier recorded at order creation, when supplied.

Example

"42018"

orders[].accession_id

string

Clinical order accession identifier, when supplied.

Example

"A640318"

orders[].source

string

Athena source label for the order, when supplied.

Example

"chart"

curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena/fetch-patient-open-orders \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"department_id":12,"limit":1,"offset":0,"org_id":64200,"patient_id":842701},"auth_id":"auth_uuid_here"}'

Request BODY

{
  "input": {
    "department_id": 12,
    "limit": 1,
    "offset": 0,
    "org_id": 64200,
    "patient_id": 842701
  },
  "auth_id": "auth_uuid_here"
}

Response BODY

{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "chart_id": "920415",
    "has_more": true,
    "limit": 1,
    "next_offset": 1,
    "offset": 0,
    "orders": [
      {
        "code": "24331-1",
        "code_description": "Lipid panel - Serum or Plasma",
        "code_set": "LOINC",
        "created_at": "2026-03-10T11:20:00-04:00",
        "created_encounter_id": "42018",
        "description": "Lipid panel, serum",
        "display_name": "Lipid panel",
        "encounter_id": "42018",
        "order_date": "2026-03-10T11:20:00-04:00",
        "order_type_id": "421",
        "order_type_name": "Lipid panel",
        "provider_loinc": "24331-1",
        "provider_order_type_id": "482",
        "provider_order_type_name": "Lipid panel",
        "source": "chart",
        "source_id": "74821",
        "source_status": "REVIEW"
      }
    ],
    "patient_id": "842701",
    "total_matching": 2
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}