Outcomes Export
Generated by the Bulk Data Export system
The order of columns is subject to change. When parsing files, please ensure to use headers rather than positional parsing to ensure you are reading the data correctly.
This file contains a row for each episode of care, per scale, containing the intake value, the current value, and a variety of indicators of treatment progress including the delta from intake and trend in treatment.
Property | Name | Field Type | Notes | |
instituteid | Institute Id | identifier | ||
instituteShortcode | Institute Shortcode | String | ||
id | Id | identifier | ||
patient_id | Patient Id | identifier | ||
patient_first_name | Patient First Name | string | ||
patient_last_name | Patient Last Name | string | ||
organization_id | Organization Id | identifer | ||
organization_name | Organization Name | string | ||
practitioner_id | Practitioner Id | identifier | ||
practitioner_first_name | Practitioner First Name | string | ||
practitioner_last_name | Practitioner Last Name | string | ||
care_episode_id | Episode of Care Id | identifier | ||
diagnostic_report_id | Diagnostic Report Id | identifier | ||
user_id | Respondent Id | identifier | User who took the assessment | |
user_first_name | Respondent First Name | string | ||
user_last_name | Respondent Last Name | string | ||
questionnaire_id | Questionnaire Id | identifier | ||
questionnaire_mnemonic | Questionnaire Unique Code | string | ||
questionnaire_name | Questionnaire Name | string | ||
score_domain | Score Type | raw | normed | interpreted | ||
population_id | Population Id | identifier | Only used when score_domain is "normed", and represents which population the scale is normed on | |
population_name | Population name | string | Only used when score_domain is "normed", and represents which population the scale is normed on | |
treatment_start_date | Treatment Start Date | datetime | The start of the care episode. This may be earlier than the first measurement if the respondent did not complete a scale at the start of treatment | |
days_between_treatment_start_and_baseline | Days Between Treatment Start and Baseline | integer | The number of calendar days between when treatment started and when a baseline measure was filled for this scale | |
baseline_date | Baseline Date | datetime | The date the first baseline measure was completed for this scale | |
baseline_severity_category | Baseline Severity Category | not_specified | mild | moderate | severe | invalid | not_supported | The clinical value of the baseline measurement | |
baseline_severity | Baseline Severity | string | Depends on scale - e.g. 'Mild Depression' | |
baseline_value | Baseline Value | number | The numerical raw value for the scale | |
encounter_target_date | Encounter Date | datetime | The encounter date for this measurement | |
session_number | Session Number | integer | The measurement number for this measurement | |
days_since_treatment_start | Days Since Treatment Start | integer | Calendar days between treatment start and this measure administration | |
weeks_since_treatment_start | Weeks Since Treatment Start | integer | Number of rounded-up weeks between treatment start and this measurement | |
last_measurement_of_week | Is Last Measurement of Week? | boolean | true if this measurement is the last measurement of this particular week. This can be used to get a unique measurement per patient per week of care | |
months_since_treatment_start | Months Since Treatment Start | integer | Number of elapsed calendar months between treatment start and this measurement | |
last_measurement_of_month | Is Last Measurement of Month? | boolean | true if this measurement is the last measurement taken in that month of treatment | |
is_first_measurement | Is First Measurement? | boolean | true if this is the first time this scale has been taken by this user | |
is_last_measurement | Is Last Measurement | boolean | true if this is the last measurement on file for this user and episode of care | |
is_first_of_severity | Is First Of Severity? | boolean | true if this is the first time this severity has been recorded. E.g. if a patient is severe and moves to 'moderate', the first time they register moderate this column will be 'true' | |
is_first_of_trend | Is First of Trend? | boolean | true if this is the first measurement where a change of trend in treatment has been observed | |
value | Value | number | the numerical score for this administration | |
severity_category | Severity Category | not_specified | mild | moderate | severe | invalid | not_supported | the severity category for this administration | |
severity | Severity | string | The severity for this value, e.g. 'Mild Depression' | |
trend | Trend | improving | stable | declining | not_supported | Whether the scale is showing a trend according to the psychometrics of the instrument | |
delta | Delta | number | The numerical change between baseline and this measurement | |
severity_better_than_intake | Severity Better Than Intake? | boolean | Whether the severity at the current measurement is better than that of intake | |
severity_worse_than_intake | Severity Worse Than Intake? | boolean | Whether the severity at the current measurement is worse than that of intake |