...
Before configuring the REDCap project to a specific Collection Protocol in OpenSpecimen, you need to 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:
...
Field Name | Mandatory? | Description |
|---|---|---|
Server Name | Yes | Free text to enter a name for the REDCap server. For example, OpenSpecimen REDCap QA server |
Host URL | Yes | The base URL for the REDCap server. For example, https://www.project-redcap.org |
Plugin Path | No | The relative path for the PHP plugin installed on the REDCap server. To check the all the plugins installed on the REDCap server, add ‘/plugins’ at the end of your REDCap base URL. For example, https://www.project-redcap.org/plugins |
Time Zone | No | The timezone of the REDCap server. |
...
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'.
...
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 The site linked with your collection protocol. |
Save PHI Data | Yes | ‘Enable'Enable' or 'Disable’ Disable' option to allow or pervent prevent the collection of the participant's 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 the REDCap project, and you have set the 'Snapshot Download Page Size' value to 5000, then OpenSpecimen will take 2 two turns to pull all 10,000 records from the REDCap. The default value is '1000’. |
Notify Users on Errors | No | Specifies the name of Specify the users' names who will be notified when there are of any error during the REDCap synchronization process. |
...
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 left) obtained from the 'data dictionary' to OpenSpecimen (on the right) as shown below.
...
Like 'Participant Level Mapping', map visits fields for the REDCap project as shown below.
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.
...
| Info |
|---|
|
Field Name | Mandatory? | Supported study type | Description |
|---|---|---|---|
Participant Fields Mapping | No | Classical/Longitudinal | Specifies the list of OpenSpecimen participant fields which that 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 | No | 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 excluded 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 included for synchronization. For examples, enrollment_date, consent_date |
Fields Exclusion List | No | Classical/Longitudinal | Defines the list of fields to be exclude excluded 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 that 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. |
...