...
Go to the CP Overview Page and click on the 'Settings' tab on the left sidebar.
Select ‘REDCap Project Configuration' and click on the 'Add Project’ button.
Click on the ‘Add New’, provide details on server name, host base URL, plugin path, and time zone, and click on the ‘save’ button.
Data Dictionary for Server Configuration
...
Go to the CP Overview Page and click on the 'Settings' tab on the left sidebar.
Select ‘REDCap Project Configuration' and click on the 'Add Project’ button.
Provide information on the project name, server name, API token, site, PHI data, snapshot download page size, and users and then click on 'Next'.
Data Dictionary for Project Configuration
...
Participant (Both classical and longitutinal longitudinal studies)
Visit (Logngitutinal Longitudinal study)
Participant Level Mapping
...
Add the list of RC-OS variable pairs separated by comma, tab, or newline.
After configuring study level mappingadding the project, you can move to the ‘Fields and Events Mapping’ page by clicking on the ' Next button.
Map REDCap variables (on the right) obtained from the 'data dictionary' to OpenSpecimen (on the left) as shown below.
List of Participant Fields and Variables
...
Event and Visit Level Mapping
...
Like 'Participant Level Mapping', map visits fields for the REDCap project as shown below in the red box.
Additionally, you can map events for the REDCap project , as shown below.
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
...
Add the list of forms/fields separated by comma, tab, or newline.
Records Inclusion Rule
The user can define certain conditions (as shown below in the red box) 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.
The expression is formed using REDCap variables as shown aboveobtained from the 'data dictionary'.
The example shown in the red box below will only fetch the records of female participants from REDCap who are 18 years old or older from REDCap.
Forms Exclusion List
The user can define the list of forms to exclude for synchronization irrespective of being mapped to participant or visit field.
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.
Fields Exclusion/Inclusion List
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.
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’.
Data Dictionary for Participant and Visit Mapping
Field Name | Mandatory? | Description |
|---|---|---|
Participant Fields Mapping | No | Specifies the list of OpenSpecimen participant fields which are mapped to their respective REDCap fields. For example, rcRecordId=ppid,dob=participant.birthDate |
Visit Fields Mapping | No | Specifies the list of OpenSpecimen visit fields which are mapped to their respective REDCap fields. For example, visit_label=eventLable,visit_site=site,visit_date=visitDate |
Records Inclusion Rule | No | Defines conditions to synchronize specific REDCap records to OpenSpecimen. The expression is formed using REDCap variables obtained from the 'data dictionary'. For example, #sex == 'Female' |
Form Exclusion List | No | Defines the list of forms to exclude for synchronization irrespective of being mapped to participant or visit field. |
Fields Inclusion List | No | Defines the list of fields to be include for synchronization. |
Fields Exclusion List | No | Defines the list of fields to be exclude for synchronization irrespective of being mapped to participant or visit field. |
Events Mapping | No | Specifies the list of OpenSpecimen events which are mapped to their respective REDCap events. |
Ignore Unmapped Events | No | Checkbox fields which can be ‘ticked’ to ignore the unmapped events of the REDCap. This prevents the creation of unwanted, unplanned events in OpenSpecimen |
Integration Points
REDCap | OpenSpecimen | Description |
|---|---|---|
Project | Collection Protocol | The RC project can be synchronized with a particular CP in OS. |
Instruments/Forms | Forms | The instruments from RC can be synchronized with forms linked with a particular CP in OS. |
Records | Participant | The records from RC can be synchronized with participants linked with a particular CP in OS. |
Visits/Events | Visits/Events | The visits/events from RC can be synchronized with visits/events linked with a particular CP in OS. |
...