Articles in this section

See more

Analytics Endpoint 'general' Metric Pool

  • Updated

Returns “general” analytics metrics, such as the number of users, patients and assessments.

The metrics are calculated when general is included in the metric_pool list for Analytics Endpoint. They are calculated per-partition, via an invoked procedure ss_general_metrics_for_partition.

Metrics are calculated over assessment_data = assessments which can be filtered by license, user, site, patient, mode, start date and end date as inherited from the endpoint call. Patient and user metrics are impacted by the permissions of license, user, site and patient. Patient and user metrics can be considered to have a reporting group defined by the start date and end date (see the individual metric terminology) - an “All” time metric, is equivalent to a group with start date = null and end date = NOW().

Metrics

Metric Key

Definition

Example

active_users

The number of Active Users 1

110

pending_users

The number of Pending Users 1

12

inactive_users

The number of Deactivated Users 1

10

active_patients

The number of Active Patients 2

120

archived_patients

The number of Archived Patients 2

18

assessing_users

The number of Assessing Users 1

12

assessed_patients

The number of Assessed Patients 1 (i.e. who have had at least one assessment).

92

assessed_patients_percentage

assessed_patients / active_patients * 100, rounded to 1 decimal place

76.7

assessments

The number of assessments

167

painchek_assessments

The number of assessments with assessment_mode = painchek

If metrics are for nrs, this will be 0

137

nrs_assessments

The number of assessments with assessment_mode = nrs

If metrics are for painchek, this will be 0

NB: assessments = painchek_assessments + nrs_assessments

30

assessments_per_assessed_patient 2

assessments / assessed_patients, rounded to 1 decimal place.

1.8

none_assessments

The number of assessments that show a pain level of none

100

mild_assessments

The number of assessments that show a pain level of mild

40

moderate_assessments

The number of assessments that show a pain level of moderate

20

severe_assessments

The number of assessments that show a pain level of severe

7

none_percentage

none_assessments / assessments * 100, rounded to 1 decimal place

59.9

mild_percentage

mild_assessments / assessments * 100, rounded to 1 decimal place

24.0

moderate_percentage

moderate_assessments / assessments * 100, rounded to 1 decimal place

12.0

severe_percentage

severe_assessments / assessments * 100, rounded to 1 decimal place

4.2

average_painchek_score

The average assessment_pain_score of painchek assessments, rounded to 1 decimal place

6.4

average_nrs_score

The average assessment_pain_score of nrs assessments, rounded to 1 decimal place

2.3

post_movement_assessments

The number of assessments with assessment_timing = movement

45

video_assessments

The number of assessments with face_mode = video

89

zero_pain_score_assessments

The number of assessments with pain_score = 0

6

Note

  1. Terminology found here - Analytics User Type Terminology

  2. Terminology found here - Analytics Patient Type Terminology

Example

{
  "active_users": 10,
  "pending_users": 12,
  "inactive_users": 10,
  "active_patients": 120,
  "archived_patients": 18,
  "assessing_users": 12,
  "assessed_patients": 92,
  "assessed_patients_percentage": 76.7,
  "assessments": 167,
  "painchek_assessments": 137,
  "nrs_assessments": 30,
  "assessments_per_assessed_patient": 1.8,
  "none_assessments": 100,
  "mild_assessments": 40,
  "moderate_assessments": 20,
  "severe_assessments": 7,
  "none_percentage": 59.9,
  "mild_percentage": 24.0,
  "moderate_percentage": 12.0,
  "severe_percentage": 4.2,
  "average_painchek_score": 6.4,
  "average_nrs_score": 2.3,
  "post_movement_assessments": 45,
  "video_assessments": 89,
  "zero_pain_score_assessments": 6
}

Related articles