...
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
...
Data Dictionary for Project Configurationdetails
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, OpenSpecimen REDCap QA server |
API Token | Yes | User specific API token generated for the project. For example, A411D356AXYRC0C8A2742EBC366778HD |
Site | No | Site linked with your collection protocol. |
Save PHI Data | Yes | ‘Enable' or 'Disable’ option to allow or pervent the collection of Personal Health Information (PHI) of the participant respectively. |
Snapshot Download Page Size | No | Specifies the maximum number of records that will be pulled from the REDCap at each interval. This is repeated ‘N' numbers of times until all records are pulled. It helps to minimize the overload to the OpenSpecimen server. For example, if there are 10,000 records in REDCap project, and you have set the 'Snapshot Download Page Size' value to 5000, then OpenSpecimen will take 2 turns to pull all 10,000 records from the REDCap. The default value is '1000’. |
Notify Users on Errors | No | Specifies the name of the users who will be notified when there are any error during REDCap synchronization process. |
...
Mapping can be done at two levels: Participant (Both classical and longitudinal studies)
...
and Visit (Longitudinal study)
Participant Level Mapping
The steps for mapping the participant fields are as follow:
...
After adding the project, you can move to the ‘Fields and Events Mapping’ page by clicking on the Next button.
Map REDCap variables (on the rightleft) obtained from the 'data dictionary' to OpenSpecimen (on the leftright) as shown below.
List of Participant Fields and Variables
...
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 Fields and Visit Mapping
...
Events Mapping
| Info |
|---|
|
Field Name | Mandatory? | Supported study type | Description |
|---|---|---|---|
Participant Fields Mapping | No | Classical/Longitudinal | 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 | Classical/Longitudinal | 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 | NoDefines conditions | Classical/Longitudinal | Defines condition/s to synchronize specific REDCap records to OpenSpecimen. The expression is formed using REDCap variables obtained from the 'data dictionary'. For example, to fetch the records of female participants who are 18 years old or older we can use following expression: #sex == 'Female' and #yearBetween(#dob, #regDate) >= 18 |
Form Exclusion List | No | Classical/Longitudinal | Defines the list of forms to be exclude for synchronization irrespective of being mapped to participant or visit field. For examples, Follow_up_year_1,Follow_up_year_2 |
Fields Inclusion List | No | Classical/Longitudinal | Defines the list of fields to be include for synchronization. For examples, enrollment_date, consent_date |
Fields Exclusion List | No | Classical/Longitudinal | Defines the list of fields to be exclude for synchronization irrespective of being mapped to participant or visit field. |
Events Mapping | No | Longitudinal | Specifies the list of OpenSpecimen events which are mapped to their respective REDCap events. |
Ignore Unmapped Events | No | Longitudinal | Checkbox fields which can be ‘ticked’ to ignore the unmapped events of the REDCap. This prevents the creation of unwanted, unplanned events in OpenSpecimen |
...