Add REDCap Project
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Add REDCap Project

To add a new REDCap project to your desired collection protocol, you can follow the steps below:

  1. Navigate to the required CP overview page → Click on the 'Settings' tab on the left sidebar.

  2. Select ‘REDCap Project Configuration' and click on the 'Add Project’ button.

image-20251219-095528.png
  1. Provide information on the project name, server name, API token, site, PHI data, snapshot download page size, and users, and then click on 'Next'.

image-20251219-100408.png

 

Data Dictionary for Project details

Field Name

Mandatory?

Description

Field Name

Mandatory?

Description

Name

Yes

Free text to enter a name for the REDCap Project. For example, Testing_RC

Server Name

Yes

Name for the REDCap server where your REDCap server is configured. For example, the OpenSpecimen REDCap QA server

API Token

Yes

User-specific API token generated for the project provided by REDCap admin. For example, A411D356AXYRC0C8A2742EBC366778HD

Site

No

The site is linked with your collection protocol.

Save PHI Data

Yes

'Enable' or 'Disable' option to allow or prevent the collection of the participant's Personal Health Information (PHI).

When “Save PHI Data” is set to Disabled, the system will not pull any RC fields marked as Identifier in the RC instrument or form setup (e.g., First Name, Last Name, MRN, DOB).

However, if participant PHI fields are mapped in the participant mapping configuration, the system will pull those fields regardless of the “Save PHI Data” setting.

Snapshot Download Page Size

No

Setting tha determine how many calls are made per subject to get all the data. Default setting is 1000.

Refer to the wiki page for more details.

Notify Users on Errors

No

Specify the users' names who will be notified of any error during the REDCap synchronization process.

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com