Step

Medable Axon provides a single-question step and a form step that can contain more than one question. You can also use an instruction step to introduce the survey or provide specific instructions and a completion step to show a user that they have completed the given task.

Below, we will describe each step type in detail and give you a visual of what that step type looks like in the app.

Autocomplete

This step allows a user to configure a set of autocomplete options to to guide the user into typing something that is configured in a list. You can force the user to choose something from the list or allow the user to type something in outside of the configured list.

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskLong Text
Completion Text ListComma separated list of completion text optionsLong Text
RestrictedIf checked, the participant can only enter a value in the completion text listCheckbox
Match AnywhereWhen selected the typed expression will match possible values anywhere as opposed to only at the beginningCheckbox
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox

App Example of Autocomplete Step

Boolean (Yes/No)

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox

App Example of Boolean Step (With Optional checked) – Notice the "Skip Question" link is available to the user

Completion

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInter nal Description of the taskShort Text
Image FileImage that will be displayed to the user in the App. Supported types: jpeg, png, gifImage File
OptionalNot ApplicableCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
SuccessBoolean that determines if this step is to be captured as a success.Checkbox
VisibleNot Application – Reserved for future useCheckbox

App Example of Completion Step

Continuous Scale

The following describes each field available to configure:

*Notes the field is required

** Notes a user facing field

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Default**Number that determines default numeric value the scale starts on when the step view is loadedNumber
Fraction Digit**Sets the number of decimal places for each point on the scaleNumber
Maximum**Number that determines maximum possible numeric value that can be input by userNumber
Maximum Description**Displays the text describing the maximumShort Text
Minimum**Number that determines minimum possible numeric value that can be input by userNumber
Minimum Description**Displays the text describing the minimumShort Text
VerticalA Boolean value indicating whether the scale is oriented verticallyCheckbox

Parameters:

  • Default Value
  • Fraction Digits
  • Minimum
  • Maximum

Validations:

Static (always the same validation):

  • max value <= min value

Dynamic (depend on the value of Fraction Digits):

Note: the value of Fraction Digits is clamped to be between 0 and 4 --i.e. if it is less than 0 it turns into 0, conversely if it's bigger than 4 it is converted to 4.

  • If Fraction Digits = 0:
    • min value can't be less than -10000
    • max value can't be greater than 10000
  • If Fraction Digits = 1:
    • min value can't be less than -1000
    • max value can't be greater than 1000
  • If Fraction Digits = 2:
    • min value can't be less than -100
    • max value can't be greater than 100
  • If Fraction Digits = 3:
    • min value can't be less than -10
    • maX value can't be greater than 10
  • If Fraction Digits = 4:
    • min value can't be less than -1
    • max value can't be greater than 1

App Example of Continuous Scale Step

Date/Time

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Calendar*Always set to GregorianText (Read Only)
Date OnlyChecked by default. Signifies that all date properties do not include an associated timeCheckbox
Default DateDate that determines the date that the date picker starts in the appDate/Time – Time not provided if Date Only is checked
Minimum DateDate that determines earliest date that is selectableDate/Time – Time not provided if Date Only is checked
Maximum DateDate that determines latest date that is selectableDate/Time – Time not provided if Date Only is checked

App Example of Date/Time Step

Email

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox

App Example of Email Step

Form

A form step allows you to display/capture multiple questions/answers in one scrolling screen. A good example of this would be a registration task that allows you to capture the basic demographic information needed to register a user.

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox

Once you create a Form Step you will need to create the Steps that will be presented in the form.

Navigation: Axon > Studies > View Study > View Task > View Form Step > Create Form Step

The following are supported step types within a form:

  • Boolean
  • Continuous Scale
  • Date/Time
  • Email
  • Image Choice
  • Integer Scale
  • Location
  • Numeric
  • Section (Form Only)
  • Text
  • Text Choice
  • Text Scale
  • Time Interval
  • Time of Day
  • Value Picker

App Example of Form Step

TIP: Use a Section Step to logically group sections of a form together

Section (Form Only)

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Title*Section TitleShort Text

App Example of Form Step with Section Steps – See section name "User Registration Information"

HealthKit Permission

A HealthKit Permission step allows you to collect data from any device that writes to the Health App on the iPhone.

How it works

  1. The researcher portal admin must configure the Healthkit Permission step to be part of a new task or include it as part of an existing task.
  2. When the participant completes the step in the app, it is no longer asked again unless you delete the app or you get a new phone and reinstall the app on the new device.
  3. After permission is granted, the app will check for data 10 seconds after authentication or 10 seconds after the public user is established in a public study, then every minute the app will check if there is data not previously uploaded and starts a process to upload anything new. If the app goes into background mode or if the phone goes into sleep mode, the app will continue to upload. If the app is killed or the phone dies, the background upload will stop and pick up where it left off when the app is opened again.

Best practice scenario: Create new Task - Create a task walking the user through granting the HealthKit Permission with an Instruction Step, HealthKit Permission Step, and a Completion Step. Assign the Task to every private group and set it to "Always Available." The reason being is that HealthKit Permissions are granted per device. If a user were to get a new device, the HealthKit Permission must be granted again for the new device per the requirements by Apple. If you do not have this task set to always available then the user will not have an opportunity to re-enable the permissions through the App, the user must do it manually through the settings on the phone.

Best practice scenario: Include in existing Task - Include the step in an "Always Available" existing task. If the user has already granted access then the step is skipped when the user completes the task. So it becomes transparent to the user. If a user were to get a new device, the HealthKit Permission must be granted again for the new device per the requirements by Apple. The user will be asked again to enable permissions when they complete the task.

NOTE: The data that is captured by this step is dependent on what the user grants when the user completes the step. See below for an example:

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
HealthKit Permission Sub Properties**
Type*Supported HealthKit data category (See table below)Text
Sub Type*Supported HealthKit sub category (See table below)Text
Use Decimal*Boolean that enables decimals for values capturedCheckbox
Access Type*Defaulted to "Read". Currently the only available value.Text
Include Historical*If checked then the app will grab all healthkit data in the Health App. If unchecked, then the Health App data that is captured will begin collecting at the point the user grants permissionCheckbox

HealthKit Category and Subcategory Table

TypeSubtypeTypeSubtype
Body MeasurementBody Mass IndexNutritionDietary Fat Total
Body Fat PercentageDietary Fat Polyunsaturated
HeightDietary Fat Monounsaturated
Body MassDietary Fat Saturated
Lean Body MassDietary Fat Unsaturated
Dietary Fat Trans
FitnessStep CountDietary Nutrition
CaloriesDietary Cholesterol
DistanceDietary Sodium
ActivityDietary Carbohydrates
Distance walking RunningDietary Fiber
Distance CyclingDietary Sugar
Distance Wheel ChairDietary Energy Consumed
Basal Energy BurnedDietary Protein
Active Energy BurnedDietary Vitamin A
Flights ClimbedDietary Vitamin B6
Nike FuelDietary Vitamin B12
Push CountDietary Vitamin C
Distance SwimmingDietary Vitamin D
Swimming Stroke CountDietary Vitamin E
Dietary Vitamin K
VitalsHeart RateDietary Calcium
Body TempuratureDietary Iron
Basal Body TemperatureDietary Thiamin
Blood Pressure SystolicDietary Riboflavin
Blood Pressure DiastolicDietary Niacin
Respitory RateDietary Folate
Dietary Biotin
ResultsOxygen SaturationDietary Pantothenic Acid
Peripheral Perfusion IndexDietary Phosphorus
Blood GlucoseDietary Iodine
Number of Times FallenDietary Magnesium
Electrodermal ActivityDietary Zinc
Inhaler UsageDietary Selenium
Blood Alcohol ContentDietary Copper
Forced Vital CapacityDietary Manganese
Forced Expiratory VolumeDietary Chromium
Peak Expiratory Flow RateDietary Molybdenum
Dietary Chloride
Dietary Potassium
Dietary Caffeine
Dietary Water
Other
UV Exposure

Image Capture

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Template Image FileA template image to be used as a guiding overlay, on top of what the camera displays, for when taking the picture. The template image is not included in the captured image. Use transparent PNGs for this, to allow participants see through it. The image is stretched to fit the available space while retaining its aspect ratio. When choosing a size for this asset, be sure to take into account the variations in device form factors. Supported types: jpeg, png, gifImage File
Accessibility InstructionsVoice read instructions on how to use the image capture stepString
Accessibility HintAccessibility hint for the capture button.String

App Example of an Image Capture Step

Image Choice

The following describes each field available to configure:

*Notes the field is required

** A user can add 1…N Image Choices. Recommend maximum of 6 images for image choices. The number of choices cannot be less than 1.

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Image Choice Sub Properties
Image File*Image that will display in the app to the userImage File
Name*Internal name for the choiceShort Text
TextText that will display in the app to the user under the imageShort Text
ValueString that determines the value of the image choiceShort Text

App Example of an Image Choice Step

Integer Scale

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
DefaultNumber that determines default numeric value the scale starts on when the step view is loadedNumber
MaximumNumber that determines maximum possible numeric value that can be input by userNumber
Maximum DescriptionDisplays the text describing the maximumShort Text
MinimumNumber that determines minimum possible numeric value that can be input by userNumber
Minimum DescriptionDisplays the text describing the minimumShort Text
VerticalA Boolean value indicating whether the scale is oriented verticallyCheckbox
Step SizeInteger number that determines the value of each step on the scale. Min of 1. Max of 15.Number

Validation

The parameters min, max and step size determine the amount of segments the integer scale will have.

  1. There's currently a limitation from Apple's ResearchKit where that amount of segments can't be less than 1 or greater than 13. The resulting amount of segments MUST be an integer result; it cannot be a fraction. See below

In other words:

(max - min) / steps = amount of segments

Rule:

1 <= amount of segments <= 13

Example (Max-Min)/StepsAmount of SegmentsResult
(10-4)/23VALID
(10-1)/24.5INVALID
(50-10)/220INVALID
(50 - (-4))/227INVALID
  1. Maximum Value MUST be larger than the Minimum Value
  2. Step Value cannot be less than 1

App Example of Integer Scale Step

Instruction

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
Image FileImage that will be displayed to the user in the App. Supported types: jpeg, png, gifImage File
OptionalNot ApplicableCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox

App Example of Instruction Step

Location

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Use Current LocationBoolean which determines if default starting location is set to current locationCheckbox

App Example of a Location Step

Numeric

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
MinimumNumber that determines minimum possible numeric value that can be input by userNumber
MaximumNumber that determines maximum possible numeric value that can be input by userNumber
Style/DecimalDetermines whether or not the numeric step is an integer or decimalCheckbox
UnitText for unit the numeric step is in (years, hours, headaches, etc.)Short Text

App Example of a Numeric Step

Text

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Maximum LengthNumber that determines maximum length of textNumber
Multiple LinesBoolean that determines whether or not multiple lines are allowed or notCheckbox
Secure Text EntryMasks the entry of the text. Commonly used for password entryCheckbox

App Example of a Text Step

Text Choice

The following describes each field available to configure:

*Notes the field is required

** A user can add 1…N Text Choices. The number of choices cannot be less than 1.

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Allow MultiplesBoolean that determines if this step allows single or multiple answers.Checkbox
Text Choice Sub Properties**
Display TextText that displays on the choiceShort Text
ValueValue stored when the choice is selectedShort Text
ExclusiveBoolean that unchecks all the others when checkedCheckbox
DescriptionDescription of the text choiceShort Text

App Example of a Text Choice Step

Text Scale

The following describes each field available to configure:

*Notes the field is required

** A user can add 1…N Text Scale Choices. Be aware that there is limited real estate on a mobile screen.

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Default IndexNumber that determines starting index of the Presentation Style document array when the view is first loaded.Number
VerticalBoolean value indicating whether the scale is oriented vertically.Checkbox
Text Scale Sub Properties**
Display TextText that displays on the choiceShort Text
ValueValue stored when the choice is selectedShort Text
ExclusiveBoolean that unchecks all the others when checkedCheckbox
DescriptionDescription of the text choiceShort Text

App Example of Text Scale Step

Time Interval

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Default IntervalDecimal number in secondsNumber
Step SizeInteger number between 1-30Number

App Example of Time Interval Step

Time of Day

The following describes each field available to configure:

*Notes the field is required

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Default HourNumber determining default hourNumber
Default MinuteNumber determining default minuteNumber
Default PeriodAM/PM SelectionPicker

App Example of Time of Day Step

Value Picker

The following describes each field available to configure:

*Notes the field is required

** A user can add 1…N Text Scale Choices. Be aware that there is limited real estate on an mobile screen. The number of choices cannot be less than 1.

FieldDescriptionData Format
Name*Internal Name for the StepShort Text
Text*Text that will be displayed to the userShort Text
DescriptionInternal Description of the taskShort Text
OptionalBoolean that sets this step as optionalCheckbox
DisabledBoolean that sets this step as disabled. If this is checked then the step will not appear in the appCheckbox
Value Picker Sub Properties**
ValueValue stored when the choice is selectedShort Text
Display TextText that displays on the choiceShort Text

App Example of Value Picker Step

Reorder Steps

Axon supports the ability to reorder steps and form steps. The Axon App displays the steps in the order they are presented in the Web tool in a linear fashion. When branching exists, the steps continue from the destination step in a linear fashion. When developing a Study, a researcher may want to reorder the steps for display. You simply drag and drop each step into the position desired in the list that displays and the order number will update automatically. Here is how a user would do that. Let's Begin!

Reorder Task Steps

Navigation: Axon > Studies > View Study > View Task > Scroll down to steps related list and click "Reorder"

Drag and Drop the steps into the desired order

Reorder Form Steps

Navigation: Axon > Studies > View Study > View Task > View Form Step > Scroll down to form steps related list and click "Reorder"

Drag and Drop the steps into the desired order

Clone a Step

Axon supports the ability to clone a step. The most common use of this is to clone a step configuration for questions that may be different but have the same scale such as a 1-10 scale or a text scale (ie. Strong Disagree >> Neutral >> Strong Agree). A user can clone all step types.

Limitations

  1. When cloning Form Steps, the sub steps are not cloned
  2. When cloning steps with images (Instruction, Image Choice, Image Capture), the resulting clone does not have the images. You must upload the images to the step manually.

Here is how you can clone a step. Let's Begin!

Navigation: Axon > Studies > View Study > View Task > View Step > Click "Clone"

Note that after you clone you see that the Name of the new step has the work "Clone" in it.


What’s Next