...
Example of Data Dictionary
...
...
Mapping can be done at three levels: Study, Participant, and Visit.
Study Level Mapping
...
Add REDCap Server
<what is this step, why is this needed?>
Click on the ‘Add New’, provide details on server name, host base URL, plugin path, and time zone, and click on the ‘save’ button.
...
Server Configuration
| Info |
|---|
Please note that the PHP plugin can be placed anywhere on the REDCap server as long as the PHP file is executable by the webserver and the functioning of the plugin PHP is not compromised. |
Field Name | Description |
|---|---|
Server Name | Free text to enter a name for the REDCap server |
Host URL | The base URL for the REDCap server |
Plugin Path | The relative path for the PHP plugin installed on the REDCap server. |
Time Zone | The timezone of the REDCap server. |
Add new Study
To link the REDCap Project with the OpenSpecimen Collection Protocol:
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.
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 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.
Server Configuration
| Info |
|---|
Please note that the PHP plugin can be placed anywhere on the REDCap server as long as the PHP file is executable by the web server and the functioning of the plugin PHP is not compromised. |
...
Field Name
...
Description
...
Server Name
...
Free text to enter a name for the REDCap server
...
Host URL
...
The base URL for the REDCap server
...
Plugin Path
...
The relative path for the PHP plugin installed on the REDCap server.
...
Time Zone
...
Mapping Participants and Visits
Mapping can be done at two levels: Participant and Visit (for Longitudinal Studies).
Participant Level Mapping
...
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 REDCap variables (on the right) obtained from the 'data dictionary' to OpenSpecimen (on the left) as shown below.
...