How to lock/unlock participant fields?

1 Configuring the lock fields in the System JSON
2 JSON Code
3 Example JSON

OpenSpecimen supports the locking of participant fields. The locked fields cannot be edited either from UI or through API. This allows biobanks to put in check constraints to ensure users do not inadvertently modify participant information fetched from external sources like REDCap, OpenClinica, OnCore, or any other clinical research system.

It is possible to configure fields to be locked depending on the source from which the participant information is fetched. The locking information can be configured only at the system level using configuration settings UI & API as described below:

Configuring the lock fields in the System JSON

Given below are steps to configure fields to be locked:

Navigate to Settings → Biospecimen → System Workflows
Click the URL displayed for setting to download workflow JSON
Open workflows JSON file in any editor of your choice
Prepare to lock fields configuration JSON as illustrated below. Add this JSON to the array in the workflow JSON file. Ensure there is only one array element named "locked-fields". The example configuration instructs OpenSpecimen to disallow edits to identified fields of participants sourced from EPIC. EPIC is an example of a data source. It could be REDCap, OpenClinica, OnCore, etc. The default data source name for participants created directly in OS is OpenSpecimen
The system workflow JSON file should look like the attached file system-workflows.json
Upload updated workflows JSON by clicking on the System Workflows setting
Test that the locking of fields is done properly based on the "data source name"

The lock fields works only if the 'Lock Field' configuration is done at the system level and source of the object is the source key mentioned in the JSON

JSON Code

    {
        "name": "locked-fields",
        "data": {
            "participant": {
              "EPIC": [
                  "cpr.participant.firstName",
                  "cpr.participant.lastName",
                  "cpr.participant.middleName",
                  "cpr.participant.birthDate",
                  "cpr.participant.gender",
                  "cpr.participant.pmis",
                  "cpr.participant.ethnicities",
                  "cpr.participant.races",
                  "cpr.participant.empi",
                  "cpr.participant.vitalStatus",
                  "cpr.participant.deathDate",
                  "cpr.participant.uid"
              ]
            }
        }
    }

How to lock/unlock participant fields?

Configuring the lock fields in the System JSON

JSON Code

Example JSON

Related content