REDCap

What is REDCap?

REDCap is a secure web application for building and managing online surveys and databases. It is specifically geared to support online and offline data capture for research studies and operations.

Integration Architecture

TODO: ADD DIAGRAM

REDCap API

We've made it simple to interface with the REDCap API. You can setup your REDCap API Token in CTRL in the Admin Portal settings page.

Getting API Access

If you do not have API access already you will need to get REDCap API access permissions from your REDCap Administrator.

You may be able to give yourself access by doing the following:

1. Navigate to "Applications" > "User Rights" on the sidebar.

   

2. Click on the user you want to give API access to.

3. Under "Basic Privileges" > "Other Privileges" ensure the API Export checkbox is ticked.

   

   NOTE: You will NOT need API Import/Update as the REDCap integration is only uni-directional.

Obtaining and Configuring REDCap API Token in CTRL

Once you have access to use the REDCap API, you will need to obtain your REDCap API Token.

1. In REDCap, navigate to "Applications" > "API" on the sidebar.

   

2. Copy your REDCap API Token

   

3. In the CTRL Admin Portal, navigate to and paste your REDCap API Token and your redcap in the CTRL settings.

   

   

4. The REDCap API URL will simply be the url of the REDCap instance with a /api appended to the end. e.g. Garvans instance is https://redcap.gimr.garvan.org.au and so our API url is https://redcap.gimr.garvan.org.au/api

API Import from REDCap

Surveys

To import surveys from REDCap into CTRL via the REDCap API, you will need to have already created the survey instruments in REDCap.

1. Ensure you have already setup your REDCap API Token in CTRL as per the instructions above.
2. Navigate to the CTRL Integrations page and select IMPORT SURVEYS.

3. You will need to input the exact instrument name of the instrument you wish to import from REDCap. You can find the exact instrument name in REDCap under "Project Home and Design" > "Designer" on the sidebar.

4. Back in CTRL, click IMPORT FROM REDCAP API. This will open up a warning modal to confirm that if you wish to import an instrument, then you will overwrite the current draft survey in CTRL.

5. Once you click YES, OVERWRITE, the survey will be imported from REDCap into CTRL. You will be automatically navigated to the Survey Editor to make any changes to the imported survey where you could also publish the survey to the participants.

Participants

Similar to surveys, to import participants from REDCap into CTRL via the REDCap API, you will need to have participants already registered in REDCap.

e.g.

We have a participant John Smith who has been registered in REDCap prior to setting up the CTRL instance. We will import John Smith into CTRL via CTRL's REDCap API integration.

1. Ensure you have already setup your REDCap API Token in CTRL as per the instructions above.
2. Navigate to the CTRL Integrations page and select IMPORT PARTICIPANTS under the REDCap section.

3. Click IMPORT FROM REDCAP API. This will open up an invite modal containing a list of emails that will be invited to your CTRL Study. You can deselect any emails you do not wish to invite. You will also be able to edit the contents of the email sent out.

4. Once you click SEND INVITES, those participants will receive an email invite to join your CTRL Study.

Manual File REDCap

You can also manually import REDCap surveys and participants into CTRL via file upload.

Surveys

For surveys, you will need to export the instrument from REDCap as a ZIP file.

1. Navigate to "Project Home and Design" > "Designer" on the sidebar.

   

2. Find the Instrument that you want to import to CTRL - Under Instrument actions , select the Choose action drop down and click Download instrument ZIP.

   

Participants

For participants, you will need to export the participant data from REDCap as a CSV file.

1. In REDCap Navigate to "Applications" > "Data Exports, Reports, and Stats" on the sidebar.

   

2. Click Make custom selections which will open up an instrument selection screen. Select the instrument you'd like to export and click Export Data.

   

   

3. Leave all values as default and click Export Data. This will download a CSV file containing all participant data for the selected instrument.

   

4. You can then upload this CSV file into CTRL via the IMPORT PARTICIPANTS button on the Integrations page. Click UPLOAD FILE and select the CSV file you just downloaded from REDCap.