| Table of Contents |
|---|
Introduction
RC REDCap doesn’t have fixed instruments for participants and visits. Therefore, you need to maps RC REDCap project instruments with OpenSpecimen participants and visits fields.
The RC REDCap variables for their respective fields (as shown below in red boxes) can be obtained from the ‘data dictionary’ available under ‘Project Home and Design’. Later you can use these variables to map fields between two servers.
...
As discussed in the REDCap (RC) Integration homepage, mapping can be done at three levels.
When no mapping is specified:
The RC REDCap record ID is used as PPID.
The time of record creation is used as a registration and visit date.
...
If the participant is not already present in the OpenSpecimen, it will create a new participant with their respective Participant level RC REDCap forms.
If the RC REDCap visit is not already present in OpenSpecimen, it will create a new visit with their respective Visit level RC REDCap forms.
Study Level Mapping
To link the RC REDCap project with the OpenSpecimen collection protocol, you need to proceed as follows:
Go to the CP Overview Page of choice and click on the 'settings' tab on the left sidebar.
Select ‘REDCap Project Configuration' and click on the 'Add Project’ button.
Add the name of your choice, appropriate server, API token generated for the project and default site for CP. You can save the PHI data to the OpenSpecimen by selecting the ‘Enabled’ option for ‘Save PHI Date'. Furthermore, you can also add users to notify them about the errors that occurred during synchronization.
‘Snapshot Download Page Size’ specifies the maximum number of records that will be fetched for the RC REDCap server 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. The default value for it is '1000’.
If you want, you can also add a new server of your choice. To do so, click on the ‘Add New’, provide details on server name, host base URL, plugin path and time zone, and click on the ‘save’ button.
...
| Info |
|---|
Please note that the PHP plugin can be placed anywhere on the RC REDCap server as long as the PHP file is executable by the web server and the functioning of the plugin PHP is not compromised. |
...
eMPI
MRN (site + MRN)
UID (SSN).
| Info |
|---|
Please note - The RC REDCap connector/plugin doesn’t use last name + DOB combination for matching as this requires users’ involvement or confirmation before using the resulting matches. The user’s involvement is ruled out because the synchronization is done automatically at scheduled times. |
...
The steps for mapping the participant fields between RC and OpenSpecimen are as follow:
Add the list of RC-OS variable pairs separated by comma, tab or newline.
After configuring study level mapping, you can move to the ‘Fields and Events Mapping’ page by clicking on the 'Next' button.
Map RC REDCap variables (on the right) obtained from the 'data dictionary' to OpenSpecimen (on the left) as shown below.
...
Like 'Participant Level Mapping', map visits fields for the RC REDCap project as shown below in the red box.
Additionally, you can map events for the RC REDCap project, as shown below.
Those events from RC REDCap which are not mapped can create unwanted, unplanned events in OpenSpecimen. To avoid this, click on the 'Ignore Unmapped Events’ checkbox.
...
The user can define certain conditions (as shown below in the red box) to synchronize specific RC 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 example shown in the red box below will only fetch the records of female participants from RC REDCap who are 18 years old or older.
...
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. | |
Participant fieldsRecords | Participant fields | The participant fields records from RC can be synchronized with participant fields participants linked with a particular CP in OS. | |
Visit fields | Visit fields | The visit fields from RC can be synchronized with visit fields linked with a particular CP in OS. | |
Events | Visits/Events | Visits/Events | The visits/events from RC can be synchronized with planned visits/events linked with a particular CP in OS. |
...