Articles in this section

See more

Tone Audiometry Active Task Export Format

  • Updated
Follow

The Tone Audiometry Active Task is based on the ResearchKit Tone Audiometry test.

When your project uses the CSV export format for Survey Results, data for Active Tasks is exported in the file SurveyToneAudiometryResults.csv. When your project uses the JSON export format, Active Task data is included in the file SurveyResults.json.

For a typical survey using this task, you'll expect to see:

  • One survey result each time the participant completes the survey.
  • Detailed output for each audio prompt within the survey.

Table of Contents

Data Fields

Field Description
SurveyToneAudiometryResultKey

A unique, auto-generated observation ID for a single tone audiometry survey.
SurveyStepResultKey A unique, auto-generated key for this step result. Can be used to cross reference with other survey results.
SurveyResultKey The key for the survey result which this step result is contained in. Can be used to cross reference with other survey results.
ParticipantIdentifier The identifier of the participant this task was for. Can be used to cross reference with Participants.
OutputVolume

A value in the range 0.0 to 1.0, with 0.0 representing the minimum volume and 1.0 representing the maximum volume.
StartDate The timestamp for when the participant started the test, in ISO 8601 format. Includes timezone offset information.
EndDate The timestamp for when the participant completed the test, in ISO 8601 format. Includes timezone offset information.
Samples

An array of collected samples, including:

 

Amplitude The minimum audio sample amplitude needed for the participant to recognize the sound (a double value between 0 and 1).


Channel The channel, either left or right, for the tone associated with the sample.


ChannelSelected The channel selected by the participant.


Frequency The frequency value in hertz for the tone associated with the sample.

Sample CSV Export

SurveyToneAudiometryResultKey,SurveyStepResultKey,SurveyResultKey,ParticipantIdentifier,OutputVolume,StartDate,EndDate,Samples
ca06cc7d-c185-eb11-88a8-001c426fd18d,ba06cc7d-c185-eb11-88a8-001c426fd18d,af06cc7d-c185-eb11-88a8-001c426fd18d,123ac,0.5,2021-03-15T15:04:40-04:00,2021-03-15T15:06:05-04:00,"[{""Amplitude"":0.0088500224883845229,""Channel"":""Left"",""ChannelSelected"":""Left"",""Frequency"":250.0},{""Amplitude"":0.0016077844388696536,""Channel"":""Left"",""ChannelSelected"":""Left"",""Frequency"":1000.0},{""Amplitude"":0.0010371084980022826,""Channel"":""Left"",""ChannelSelected"":""Left"",""Frequency"":4000.0},{""Amplitude"":0.0009883851999693469,""Channel"":""Right"",""ChannelSelected"":""Right"",""Frequency"":8000.0},{""Amplitude"":0.0021459301228170529,""Channel"":""Left"",""ChannelSelected"":""Left"",""Frequency"":8000.0},{""Amplitude"":0.0020451144481472656,""Channel"":""Left"",""ChannelSelected"":""Left"",""Frequency"":500.0},{""Amplitude"":0.0035471793684111966,""Channel"":""Right"",""ChannelSelected"":""Right"",""Frequency"":500.0},{""Amplitude"":0.0026293681851127545,""Channel"":""Right"",""ChannelSelected"":""Right"",""Frequency"":250.0},{""Amplitude"":0.00092696276222181434,""Channel"":""Right"",""ChannelSelected"":""Right"",""Frequency"":1000.0},{""Amplitude"":0.0026434639930827813,""Channel"":""Right"",""ChannelSelected"":""Right"",""Frequency"":4000.0}]"

Sample JSON Export

Note that since the JSON export is included in the SurveyResults.json file, some of the reference keys either do not apply, or are part of the overall survey step data.

{"SurveyResultKey":"af06cc7d-c185-eb11-88a8-001c426fd18d","SurveyKey":"5ba5ad2b-c085-eb11-88a8-001c426fd18d","SurveyName":"tone","ParticipantIdentifier":"123ac","SurveyTaskKey":"1df84a70-c085-eb11-88a8-001c426fd18d","Type":"Survey","SurveyVersion":0,"StartDate":"2021-03-15T15:03:46-04:00","EndDate":"2021-03-15T15:06:08-04:00","DevicePlatform":"iOS","DeviceName":"iPhone8,4","DeviceOSVersion":"14.3","InsertedDate":"2021-03-15T19:06:08Z","StepResults":[{"SurveyStepResultKey":"b606cc7d-c185-eb11-88a8-001c426fd18d","StepIdentifier":"instruction","StartDate":"2021-03-15T15:03:46-04:00","EndDate":"2021-03-15T15:03:48-04:00","Results":[]},{"SurveyStepResultKey":"b706cc7d-c185-eb11-88a8-001c426fd18d","StepIdentifier":"instruction1","StartDate":"2021-03-15T15:03:48-04:00","EndDate":"2021-03-15T15:04:18-04:00","Results":[]},{"SurveyStepResultKey":"b806cc7d-c185-eb11-88a8-001c426fd18d","StepIdentifier":"tone.audiometry.practice","StartDate":"2021-03-15T15:04:18-04:00","EndDate":"2021-03-15T15:04:35-04:00","Results":[]},{"SurveyStepResultKey":"b906cc7d-c185-eb11-88a8-001c426fd18d","StepIdentifier":"countdown","StartDate":"2021-03-15T15:04:35-04:00","EndDate":"2021-03-15T15:04:40-04:00","Results":[]},{"SurveyStepResultKey":"ba06cc7d-c185-eb11-88a8-001c426fd18d","StepIdentifier":"tone.audiometry","StartDate":"2021-03-15T15:04:40-04:00","EndDate":"2021-03-15T15:06:05-04:00","Results":[{"Type":"ToneAudiometryResult","SurveyToneAudiometryResultKey":"ca06cc7d-c185-eb11-88a8-001c426fd18d",
"OutputVolume":0.5,
"Samples":[
   {
   "Amplitude":0.00070165115591499638,
   "Channel":"Right",
   "ChannelSelected":"Right",
   "Frequency":8000.0
   },
   {
   "Amplitude":0.0012621798569423931,
   "Channel":"Left",
   "ChannelSelected":"Left",
   "Frequency":250.0
   },
   {
   "Amplitude":0.00042571724699127871,
   "Channel":"Left",
   "ChannelSelected":"Left",
   "Frequency":4000.0
   },
   {
   "Amplitude":0.00038736577342580661,
   "Channel":"Right",
   "ChannelSelected":"Right",
   "Frequency":4000.0
   },
   {
   "Amplitude":0.00037249568395183221,
   "Channel":"Left",
   "ChannelSelected":"Left",
   "Frequency":8000.0
   },
   {
   "Amplitude":0.00045616424872377894,
   "Channel":"Right",
   "ChannelSelected":"Right",
   "Frequency":500.0
   },
   {
   "Amplitude":0.0003900508646917188,
   "Channel":"Right",
   "ChannelSelected":"Right",
   "Frequency":1000.0
   },
   {
   "Amplitude":0.00040749402486800501,
   "Channel":"Right",
   "ChannelSelected":"Right",
   "Frequency":250.0
   },
   {
   "Amplitude":0.00037767761509653727,
   "Channel":"Left",
   "ChannelSelected":"Left",
   "Frequency":500.0
   },
   {
   "Amplitude":0.00036993144170009522,
   "Channel":"Left",
   "ChannelSelected":"Left",
   "Frequency":1000.0
   }

Related articles