Skip to main content

Data Export - Research Data Set

Research Data Set (questionnaire-based)​

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.

What this export contains​

Most people should use the Outcomes export instead. The research sets are wide, specialist files built for formal research and statistical analysis, and they take more work to interpret. For routine reporting on treatment progress and effectiveness, Outcomes is already analysis-ready and easier to work with. Choose this research set only when you specifically need item-level research data.

A research-oriented export with one row per questionnaire response, including demographics, appointment and respondent details, plus extra columns holding the answer value for each question. This is the item-level research set and can be very wide depending on the measures taken.

Example questions this export can answer​

  • Build an item-level research dataset keyed by response
  • Analyze answers alongside demographics and session number
  • Prepare data for statistical analysis of measures over time
PropertyNameField TypeNotes
instituteidInstitute Ididentifier
instituteShortcodeInstitute ShortcodeString
questionnaireResponseIdQuestionnaire Response IDidentifierQuestionnaire Response
questionnaireStatusQuestionnaire Statusenumregistered | partialpreliminaryfinal
subjectMrnSubject MRNidentifierPatient
subjectLegalFirstNameSubject Legal First Namestring
subjectLegalLastNameSubject Legal Last Namestring
subjectLegalNameSubject Legal Namestring
subjectPreferredFirstNameSubject Preferred First Namestring
subjectPreferredLastNameSubject Preferred Last Namestring
subjectPreferredNameSubject Preferred Namestring
subjectPreferredPronounsSubject Preferred Pronounsstring
subjectGenderSubject Genderstring
subjectDobSubject DOBdate
subjectBirthYearSubject Birth Yeardate
subjectMirahIdSubject Mirah IDidentifierID of the patient or related person
organizationIdOrganization IDIdentifierOrganization
organizationNameOrganization Namestring
appointmentDateAppointment Datetimestamp
appointmentLocalDateAppointment Local Datetimestamp
practitionerIDPractitioner IDidentifier
practitionerNamePractitioner Namestring
begunDateBegun Datetimestamp
completionDateCompletion Datetimestamp
daysFromIntakeDays From IntakestringField inactive. Will always return 0.
sessionNumberSession Numberstring
performerFirstNamePerformer First Namestring
performerLastNamePerformer Last Namestring
performerRelationPerformer Relationenumpatient | providerguardianteachermotherfatherchild
[scales]These columns will contain answer values for each question where there is a saved response.There are rare instances where multiple answer values can exist for a question. Some questions are multi-select, some scales with multiple respondents, and some behavior edge-cases will create two answers.