Tross
Demo dataBook a demo
ATHENA

Fetch measurement types

List behavioral measurement types and components.

POSThttps://preview.ontross.com/api/integrations/athena/fetch-measurement-types
Request Fields
input.org_id
integer
required
Practice context, shown in the athenanet portal URL.
Example
25910
input.department_id
integer
required
Department the session opens, shown in the portal URL.
Example
1
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
measurement_types
array
Behavioral measurement catalog, each entry with its components.
measurement_types[].measurement_type_id
string
Which catalog measurement a target or baseline tracks.
Example
"9081"
measurement_types[].system
string
Coding or source system the code belongs to, like Snomed.
Example
"Snomed"
measurement_types[].system_id
string
Identifier the source system uses for this measurement.
Example
"720433000"
measurement_types[].display_name
string
Readable label supplied for this assessment definition.
Example
"PHQ-9 total score"
measurement_types[].components
array
Individual measures making up the measurement type, with units.
measurement_types[].components[].measurement_type_component_id
string
Athena's identifier for one measure inside a measurement type.
Example
"9082"
measurement_types[].components[].display_name
string
Readable label supplied for this individual measure.
Example
"Total score"
measurement_types[].components[].display_order
integer
Where the component sits in Athena's display order.
Example
1
measurement_types[].components[].system
string
Coding or source system the code belongs to, like Snomed.
Example
"Snomed"
measurement_types[].components[].system_id
string
Identifier the source system uses for this measurement.
Example
"720433000"
measurement_types[].components[].units
string
Unit Athena records the component's values in.
Example
"score"
measurement_types[].components[].data_type
string
How the component's value is typed, as Athena declares it.
Example
"Integer"
measurement_types[].components[].min
number
Lowest value the component accepts, when Athena sets one.
Example
0
measurement_types[].components[].max
number
Highest value the component accepts, when Athena sets one.
Example
27
measurement_types[].components[].precision
integer
Decimal places Athena allows for the component value.
Example
0
measurement_types[].components[].scale
integer
Scale Athena applies to the component value.
Example
0
Code
curl --request POST \
  --url https://preview.ontross.com/api/integrations/athena/fetch-measurement-types \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"org_id":25910,"department_id":1},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "org_id": 25910,
    "department_id": 1
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "measurement_types": [
      {
        "measurement_type_id": "9081",
        "system": "Snomed",
        "system_id": "720433000",
        "display_name": "PHQ-9 total score",
        "components": [
          {
            "measurement_type_component_id": "9082",
            "display_name": "Total score",
            "display_order": 1,
            "system": "Snomed",
            "system_id": "720433000",
            "units": "score",
            "data_type": "Integer",
            "min": 0,
            "max": 27,
            "precision": 0,
            "scale": 0
          }
        ]
      }
    ]
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}