Tross
Demo dataBook a demo
ATHENA PROD

Add client characteristics

Record client strengths, barriers, abilities, preferences, and supports.

POSThttps://preview.ontross.com/api/integrations/athena-prod/add-client-characteristics
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.strengths
array
Patient strengths, saved as Strength observations, one per string.
Example
["Participates in treatment planning"]
input.barriers
array
Barriers from fetch-needs, keeping both SNOMED fields.
Example
[{"SnomedCode":"105419003","SnomedDescription":"Academic underachievement"}]
input.barriers[].SnomedCode
string
Barrier SNOMED code, copied unchanged from fetch-needs.
Example
"105419003"
input.barriers[].SnomedDescription
string
Barrier wording Athena stores as the observation summary.
Example
"Academic underachievement"
input.abilities
array
Patient abilities, saved as Ability observations, one per string.
Example
["Can identify treatment goals"]
input.preferences
array
Patient preferences, saved as Preference observations, one per string.
Example
["Prefers collaborative planning"]
input.supports
array
People or services supporting the patient, saved as Support observations.
Example
["Care team"]
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
boolean
Always true, since failures raise an error instead.
Example
true
observation_count
integer
How many client characteristics the call submitted.
Example
5
observations_submitted
array
The observation payloads sent to Athena, echoed back.
add_observation_result
any
Raw Athena response from the observation write.
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena-prod/add-client-characteristics \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":47902,"department_id":1,"patient_id":4044,"strengths":["Participates in treatment planning"],"barriers":[{"SnomedCode":"105419003","SnomedDescription":"Academic underachievement"}],"abilities":["Can identify treatment goals"],"preferences":["Prefers collaborative planning"],"supports":["Care team"]},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 47902,
    "department_id": 1,
    "patient_id": 4044,
    "strengths": [
      "Participates in treatment planning"
    ],
    "barriers": [
      {
        "SnomedCode": "105419003",
        "SnomedDescription": "Academic underachievement"
      }
    ],
    "abilities": [
      "Can identify treatment goals"
    ],
    "preferences": [
      "Prefers collaborative planning"
    ],
    "supports": [
      "Care team"
    ]
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "created": true,
    "observation_count": 5,
    "observations_submitted": [
      {}
    ],
    "add_observation_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"
}