...

Before configuring the REDCap project to a specific Collection Protocol in OpenSpecimen, you must establish a link between your desired REDCap and OpenSpecimen servers. This will helps the OpenSpecimen to pull the data from the REDCap projects associated with the REDCap server using API tokens. Furthermore, once the server is configured, you can reuse the saved configuration multiple times for adding the projects. You can add the REDCap Server in the following steps:

1. Go to the CP Overview Page and click on the 'Settings' tab on the left sidebar.

   Image Modified

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

   Image Modified

3. Click on the ‘Add New’, provide details on server name, host base URL, plugin path, and time zone, and click on the ‘save’ button.

   Image ModifiedImage Modified

Data Dictionary for Server Configuration

...

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

1. Go to the CP Overview Page and click on the 'Settings' tab on the left sidebar.

   Image Modified

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

   Image Modified

3. 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 Modified

Data Dictionary for Project details

...

Participant Level Mapping

1. After adding the project, you can move to the ‘Fields and Events Mapping’ page by clicking the Next button.

2. Map REDCap variables (on the left) obtained from the 'data dictionary' to OpenSpecimen (on the right) as shown below.

   Image Modified

List of Participant Fields and Variables

...

Event and Visit Level Mapping

1. Like 'Participant Level Mapping', map visits fields for the REDCap project as shown below.

   Image Modified

2. Additionally, you can map events for the REDCap project, as shown below.

   Image Modified

3. Those events from REDCap which are not mapped can create unwanted, unplanned events in OpenSpecimen. To avoid this, click on the 'Ignore Unmapped Events’ checkbox as shown above in the red box.

List of Visit Fields and Variables

...

Records Inclusion Rule

1. The user can define certain conditions to synchronize specific REDCap records to OpenSpecimen. Once applied, the system will ignore all other records that don’t satisfy the criteria irrespective of being mapped to the participant or visit field.

2. The expression is formed using REDCap variables obtained from the 'data dictionary'.

3. The example shown below will only fetch the records of female participants who are 18 years or older from REDCap.

   Image Modified

4. The example show below will only fetch the records where the eligibility has value either ‘eligible, needs scheduled' or 'eligible, scheduled’.

   Image Added

Forms Exclusion List

1. The user can define the list of forms to exclude for synchronization irrespective of being mapped to participant or visit field.

2. If the user provides the list to the ‘Forms Exclusion list’ text box, then all the forms will be synchronized except the forms mentioned on the list.

   Image Modified

Fields Exclusion/Inclusion List

1. Like ‘Forms Exclusion List’, the user can also define the list of fields to either include or exclude for synchronization. The user can’t define both the parameters at once.

2. If the user provides the list to the ‘Field Exclusion list’ text box, then all the fields will be synchronized except the fields mentioned on the list. On the other hand, only specified fields will be synchronized if the user provides the list to the ‘Field Inclusion list’.

   Image Modified

Data Dictionary for Fields and Events Mapping

...

To add more than one REDCap project to your collection protocol in OpenSpecimen, you can follow below steps:

1. Go to the REDCap configuration page for your collection protocol of choice.

2. Click on the ‘More' option and select ‘+Add Another’.

3. Configure the new project as shown above.

   Image Modified

Mapping PVs from REDCap to corresponding PVs of OpenSpecimen

...

Expand
title Steps for mapping one PV from REDCap to one PV on OpenSpecimen
Let's say you want to map the gender value "M" received from the REDCap project to the corresponding OpenSpecimen PV "Male". To do so, you can follow the given steps: Go to Extras from the homepage and select Dropdown Manager. Click on the "Gender" attribute and click on 'Male' PV. Click on 'Edit', and under properties, enter the name of the PV Mapping Key and its corresponding value for your REDCap study. Mapping Specific CP The property name is the same as the "PV Mapping Key" displayed on the OS-RC configuration page. Mapping for all CPs under a single site The property name is RC_<site_id>. The site ID can be obtained from the sites list view in the following steps: Go to the 'site' page from the homepage and select the sites you are interested in. Click on the 'Export' button to download the .csv file. Open the file, and you can see the 'site id' as 'identifier'. Mapping all REDCap projects irrespective of sites or CP The property name is RC, as illustrated in the below image.

...