Tross
Demo dataBook a demo
ATHENA PROD

Add behavioral health goal

Add a behavioral treatment goal.

POSThttps://preview.ontross.com/api/integrations/athena-prod/add-behavioral-health-goal
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_name
string
required
Behavioral-health goal name as clinicians see it in the plan.
Example
"Manage anxiety more effectively"
input.start_date
string
required
Treatment aim beginning, passed through without local date parsing.
Example
"2026-10-12T04:00:00.000Z"
input.end_date
string
required
Treatment aim completion boundary, passed through without local date parsing.
Example
"2027-01-12T05:00:00.000Z"
input.review_due_date
string
required
When the goal is next due for review.
Example
"2026-08-15T04:00:00.333Z"
input.baseline_description
string
Where the patient stands when the goal starts.
Example
"Initial treatment-plan baseline"
Default
""
input.modality_values
array
Treatment modality IDs from fetch-treatment-modalities, added separately.
Example
["432"]
input.client_goal_statement
string
Goal in the patient's own words, saved as patient statement.
Example
"I want to manage anxiety more effectively."
input.priority
string
Priority label, and sending any value flags the goal as priority.
Example
"Medium"
Accepted values
LowMediumHigh
input.linked_problem_ids
array
Concern problem IDs from create-treatment-plan-concern to link here.
Example
["49107"]
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
created_goal_id
string
Goal Athena created on the behavioral health concern.
Example
"9086"
patient_id
integer
Patient whose chart is read or written, from the chart URL.
Example
9074621
health_concern_id
string
Parent behavioral concern, which doubles as the treatment plan id.
Example
"9064"
modality_results
array
One Athena response per modality added to the goal.
patient_statement_result
any
Raw response from saving the patient statement, null when omitted.
priority_result
any
Raw response from setting goal priority, null when omitted.
problem_goal_link_result
any
Raw response from linking problems, null when none passed.
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/add-behavioral-health-goal \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":47902,"department_id":1,"patient_id":4044,"goal_name":"Manage anxiety more effectively","baseline_description":"Initial treatment-plan baseline","start_date":"2026-10-12T04:00:00.000Z","end_date":"2027-01-12T05:00:00.000Z","review_due_date":"2026-08-15T04:00:00.333Z","modality_values":["432"],"client_goal_statement":"I want to manage anxiety more effectively.","priority":"Medium","linked_problem_ids":["49107"]},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 47902,
    "department_id": 1,
    "patient_id": 4044,
    "goal_name": "Manage anxiety more effectively",
    "baseline_description": "Initial treatment-plan baseline",
    "start_date": "2026-10-12T04:00:00.000Z",
    "end_date": "2027-01-12T05:00:00.000Z",
    "review_due_date": "2026-08-15T04:00:00.333Z",
    "modality_values": [
      "432"
    ],
    "client_goal_statement": "I want to manage anxiety more effectively.",
    "priority": "Medium",
    "linked_problem_ids": [
      "49107"
    ]
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "created_goal_id": "9086",
    "patient_id": 9074621,
    "health_concern_id": "9064",
    "modality_results": [
      {}
    ],
    "patient_statement_result": null,
    "priority_result": null,
    "problem_goal_link_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"
}