Tross
ATHENA PROD

Perform document action

Perform document action in Athena Prod

POSThttps://api.ontross.com/api/integrations/athena-prod/perform-document-action
Request Fields
input.org_id
integer
required
Org id
Example
1
input.patient_id
integer
required
Patient id
Example
1
input.document_id
string
required
Document id
Example
"12345"
input.expected_version
string
required
Expected version
Example
"string"
input.edit_context_token
string
required
Edit context token
Example
"string"
input.action
string
required
Action
Example
"assign_data_entry"
Accepted values
assign_data_entrycomplete_data_entry
input.department_id
integer
required
Runtime Athena context department; distinct from the portal route number.
Example
1
input.assignee_username
string
Assignee username
Example
"string"
input.action_note
string
Action note
Example
"string"
input.pin_action_note_to_top
boolean
Pin action note to top
Example
false
input.pin_document_to_chart_top
boolean
Pin document to chart top
Example
false
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
outcome
string
Outcome
document
object
Output object.
document.document_id
string
Source identifiers remain strings.
document.patient_id
string
Source identifiers remain strings.
document.chart_id
string
Source identifiers remain strings.
document.department_id
string
Source identifiers remain strings.
document.document_class
string
Document class
document.label_id
string
Source identifiers remain strings.
document.label_name
string
Label name
document.provider_username
string
Provider username
document.source_status
string
Source status
document.actual_assignee_username
string
Actual assignee username
document.document_date
string
Document date
document.pin_action_note_to_top
boolean
Pin action note to top
document.version_token
string
Version token
document.action_note_id
string
Action note id
document.edit_context_token
string
Edit context token
document.allowed_actions
array
List of allowed actions.
document.action_context_expires_at
string
Action context expires at
document.pin_semantics
string
Pin semantics
document.chart_top_visibility_verified
boolean
Chart top visibility verified
action_note_id
string
Action note id
metadata_verified
boolean
Metadata verified
warnings
array
List of warnings.
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/athena-prod/perform-document-action \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":1,"patient_id":1,"document_id":"12345","expected_version":"string","edit_context_token":"string","action":"assign_data_entry","assignee_username":"string","action_note":"string","pin_action_note_to_top":false,"pin_document_to_chart_top":false,"department_id":1},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 1,
    "patient_id": 1,
    "document_id": "12345",
    "expected_version": "string",
    "edit_context_token": "string",
    "action": "assign_data_entry",
    "assignee_username": "string",
    "action_note": "string",
    "pin_action_note_to_top": false,
    "pin_document_to_chart_top": false,
    "department_id": 1
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "outcome": "updated",
    "document": {
      "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
    },
    "action_note_id": "string",
    "metadata_verified": true,
    "warnings": [
      "string"
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}