Tross
ATHENA

Fetch document options

Fetch document options in Athena

POSThttps://api.ontross.com/api/integrations/athena/fetch-document-options
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.label_query
string
Label query
Example
"remote patient monitoring"
input.limit
integer
Limit
Example
25
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
document_classes
array
List of document classes.
labels
array
List of labels.
labels[].label_id
string
Label id
labels[].name
string
Name
department_options
array
List of department options.
department_options[].department_id
string
Department id
department_options[].name
string
Name
provider_options
array
List of provider options.
provider_options[].username
string
Username
provider_options[].display_name
string
Display name
assignee_options
array
List of assignee options.
assignee_options[].username
string
Username
assignee_options[].display_name
string
Display name
allowed_actions
array
List of allowed actions.
limits
object
Limits object.
limits.max_files
integer
Max files
limits.max_bytes
integer
Max bytes
limits.accepted_content_types
array
List of accepted content types.
limits.max_pages
integer
Max pages
context_token
string
Context token
expires_at
string
Expires at
capability_status
string
Capability status
limitations
array
List of limitations.
pin_semantics
string
Pin semantics
document_pin_capability_status
string
Document pin capability status
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena/fetch-document-options \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":12345,"department_id":1,"patient_id":100001,"document_class":"CLINICALDOCUMENT","label_query":"string","limit":1},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 12345,
    "department_id": 1,
    "patient_id": 100001,
    "document_class": "CLINICALDOCUMENT",
    "label_query": "string",
    "limit": 1
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "document_classes": [
      "string"
    ],
    "labels": [
      {
        "label_id": "string",
        "name": "string"
      }
    ],
    "department_options": [
      {
        "department_id": "string",
        "name": "string"
      }
    ],
    "provider_options": [
      {
        "username": "string",
        "display_name": "string"
      }
    ],
    "assignee_options": [
      {
        "username": "string",
        "display_name": "string"
      }
    ],
    "allowed_actions": [
      "string"
    ],
    "limits": {
      "max_files": 1,
      "max_bytes": 1,
      "accepted_content_types": [
        "string"
      ],
      "max_pages": 1
    },
    "context_token": "string",
    "expires_at": "2019-08-24T14:15:22Z",
    "capability_status": "available",
    "limitations": [
      "string"
    ],
    "pin_semantics": "action_note",
    "document_pin_capability_status": "available"
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}