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 REDCap API Token

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 settings 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

Import Files from REDCap

Survey Import

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.

Participant Import

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.