Versions Compared

Version Old Version 37 New Version 38
Changes made by

Ankita Chavan

Saurav Singh (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Expand

  1. Go to the CP Overview Page and click on the 'Settings' tab on the left sidebar.

    image-20240829-083150.png

  2. Select ‘REDCap Project Configuration' and click on the 'Add Project’ button.

    image-20240829-083032.png

  3. 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 details

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

The site linked with your collection protocol.

Save PHI Data

Yes

'Enable' or 'Disable' option to allow or prevent the collection of the participant's Personal Health Information (PHI).

Info

When you use the ''Save PHI data" option as Disabled, OS will not pull any RC field marked as 'Identifier' in the RC instrument/form set-up. Usually, these fields are 'First Name', 'Last Name', 'MRN', 'DOB', etc.

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 two turns to pull all 10,000 records from the REDCap.

The default value is '1000’.

Notify Users on Errors

No

Specify the users' names who will be notified of any error during the REDCap synchronization process.

...

Note

When you are adding a mapping for participant or visit fields, make sure there is no space between OS and RC field. If you introduce a space, the mapping will not be saved.

For example:

Correct mapping: rcRecordId=ppid

Incorrect mapping: rcRecordId = ppid

Participant Level Mapping

...