Tross
ATHENA

Fetch patient documents

Fetch patient documents in Athena

POSThttps://api.ontross.com/api/integrations/athena/fetch-patient-documents
Request Fields
input.org_id
integer
required
Org id
Example
12345
input.department_id
integer
required
Department id
Example
1
input.patient_id
integer
required
Patient id
Example
100001
input.document_class
string
required
Document class
Example
"CLINICALDOCUMENT"
Accepted values
CLINICALDOCUMENT
input.start_date
string
Start date
Example
"2026-01-01"
input.end_date
string
End date
Example
"2026-01-01"
input.limit
integer
Limit
Example
25
input.offset
integer
Offset
Example
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
documents
array
List of documents.
documents[].document_id
string
Source identifiers remain strings.
documents[].patient_id
string
Source identifiers remain strings.
documents[].chart_id
string
Source identifiers remain strings.
documents[].department_id
string
Source identifiers remain strings.
documents[].document_class
string
Document class
documents[].label_id
string
Source identifiers remain strings.
documents[].label_name
string
Label name
documents[].provider_username
string
Provider username
documents[].source_status
string
Source status
documents[].actual_assignee_username
string
Actual assignee username
documents[].document_date
string
Document date
documents[].pin_action_note_to_top
boolean
Pin action note to top
documents[].version_token
string
Version token
documents[].action_note_id
string
Action note id
documents[].edit_context_token
string
Edit context token
documents[].allowed_actions
array
List of allowed actions.
documents[].action_context_expires_at
string
Action context expires at
documents[].pin_semantics
string
Pin semantics
documents[].chart_top_visibility_verified
boolean
Chart top visibility verified
has_more
boolean
Has more
next_offset
integer
Next offset
coverage
object
Coverage object.
coverage.source
string
Source
coverage.covered_classes
array
List of covered classes.
coverage.covered_statuses
array
List of covered statuses.
coverage.completeness
string
Completeness
coverage.limitations
array
List of limitations.
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena/fetch-patient-documents \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":12345,"department_id":1,"patient_id":100001,"start_date":"2026-01-01","end_date":"2026-01-01","document_class":"CLINICALDOCUMENT","limit":1,"offset":0},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 12345,
    "department_id": 1,
    "patient_id": 100001,
    "start_date": "2026-01-01",
    "end_date": "2026-01-01",
    "document_class": "CLINICALDOCUMENT",
    "limit": 1,
    "offset": 0
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "documents": [
      {
        "document_id": "string",
        "patient_id": "string",
        "chart_id": "string",
        "department_id": "string",
        "document_class": "string",
        "label_id": "string",
        "label_name": "string",
        "provider_username": "string",
        "source_status": "string",
        "actual_assignee_username": "string",
        "document_date": "2019-08-24",
        "pin_action_note_to_top": true,
        "version_token": "string",
        "action_note_id": "string",
        "edit_context_token": "string",
        "allowed_actions": [
          "string"
        ],
        "action_context_expires_at": "2019-08-24T14:15:22Z",
        "pin_semantics": "action_note",
        "chart_top_visibility_verified": true
      }
    ],
    "has_more": true,
    "next_offset": 0,
    "coverage": {
      "source": "string",
      "covered_classes": [
        "string"
      ],
      "covered_statuses": [
        "string"
      ],
      "completeness": "complete_for_requested_scope",
      "limitations": [
        "string"
      ]
    }
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}