Tross
Demo dataBook a demo
ATHENA PROD

Set goal status

Update a treatment goal's lifecycle status.

POSThttps://preview.ontross.com/api/integrations/athena-prod/set-goal-status
Request Fields
input.org_id
integer
required
Practice context, shown in the athenanet portal URL.
Example
47902
input.department_id
integer
required
Department the session opens, shown in the portal URL.
Example
1
input.patient_id
integer
required
Patient whose chart is read or written, from the chart URL.
Example
4044
input.goal_id
string
required
Goal receiving this change, returned as created_goal_id.
Example
"4216"
input.goal_status
string
required
Lifecycle state for the goal, either active or inactive.
Example
"active"
Accepted values
activeinactive
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
goal_id
string
Goal receiving this change, returned as created_goal_id.
Example
"9086"
health_concern_id
string
Parent behavioral concern, which doubles as the treatment plan id.
Example
"9064"
patient_id
integer
Patient whose chart is read or written, from the chart URL.
Example
9074621
goal_status
string
Lifecycle state for the goal, either active or inactive.
Example
"active"
mutation_result
any
Raw Athena response from the status change.
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/set-goal-status \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":47902,"department_id":1,"patient_id":4044,"goal_id":"4216","goal_status":"active"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 47902,
    "department_id": 1,
    "patient_id": 4044,
    "goal_id": "4216",
    "goal_status": "active"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "goal_id": "9086",
    "health_concern_id": "9064",
    "patient_id": 9074621,
    "goal_status": "active",
    "mutation_result": null
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}