REDCap Integration

Was this helpful?

Inclivio sends several survey parameters to your participants' surveys to help you track survey completion, structure the flow of your survey, and capture metadata in your final dataset. These values are sent in the form of key/value pairs in the survey URL. REDCap reads these values through hidden text box fields that you add to your survey.

On this page you will find information about:

Important: use a separate REDCap project for your EMA study

You need to create a separate REDCap project for your EMA surveys. Do not add your EMA surveys to the REDCap project that holds the rest of your study's surveys.

You cannot use REDCap's participant tracking features (such as record IDs or the participant list) to identify participants.

Instead, you will use the participantidsurvey parameter that Inclivio sends with every ping to keep track of who is who.

Adding Survey Parameters As Hidden Fields

REDCap reads survey parameters in the form of a text box field with the @HIDDEN-SURVEY Action Tag / Field Annotation. Action Tags in REDCap surveys allow you to customize the behavior of your field (i.e., question). The @HIDDEN-SURVEY action tag hides your questions from participants but still includes it in your survey flow, allowing REDCap to unobstrusively capture survey parameter metadata.

Repeat the steps below for each survey parameter you want to capture. At a minimum, add a field for participantid.

  1. Click Add Field -> Select 'Text Box'.

    REDCap Text Box
  2. In 'Action Tags / Field Annotation', type @HIDDEN-SURVEY.

    REDCap Action Tag
  3. In 'Variable Name', enter the name of the survey parameter (e.g., 'participantid').

    REDCap Variable Name
  4. Click 'Save'.

    REDCap Save
Was this helpful?