This is a paid plugin. Please email contact@krishagni.com for more details

Introduction

The OpenSpecimen-REDCap plugins are paid plugins available to clients who have an Enterprise Support contract with Krishagni. This plugin supports the following use cases:

It will link a REDCap Project with an Openspecimen Collection Protocol.
It will fetch all the clinical data from REDCap and store it in OpenSpecimen.
It will support both types of studies from REDCap: Classical and Longitudinal.

Advantage

This plugin is particularly beneficial for those institutes that store clinical data in REDCap and biospecimen data in OpenSpecimen. Hence, it acts as a bridge between two datasets helping to combine the scattered data across multiple platforms. Some of the highlights of installing this plugin are as follow:

Productivity: It saves time and avoids human errors in doing duplicate data entries
Powerful queries: It helps to find specimens and participants using integrated queries across datasets from OpenSpecimen and REDCap.
SpecimenCatalog: You can also include REDCap data in the SpecimenCatalog.

Deployment

The deployment can be divided into two parts:

Download

REDCap PHP plugin: Click on this link to download the REDCap PHP plugin.
OpenSpecimen-REDCap Plugin: To download the OpenSpecimen-REDCap plugin, please contact Krishagni.

Installation

Installation of these plugins to the remote server helps in sharing data or information across datasets. There are two parts to this process:

Installation of PHP plugins

Log in to the REDCap server and navigate to the REDCap install directory containing the file redcap_connect.php and database.php files.

Following are example commands executed in our dev environment.

$ cd /home/var-www/html/redcap/
$ ls database.php redcap_connect.php
database.php  redcap_connect.php

Create a new 'plugins' directory if not present.
```
$ mkdir -p plugins
```
Download the PHP plugin and copy it to the plugins directory.
```
$ cp $RC_OS_PLUGIN/openspecimen_plugin.php plugins
```
To ensure that the plugins are correctly installed, you can invoke the following API using the HTTP client program of choice.

Click here to see the example

Below is an example done using Postman

Replace <host> with hostname where REDCap server is deployed
Replace <Project API token> with actual API token issued for accessing REDCap project using APIs
In response, you should see the REDCap audit log events nicely formatted using JSON.

Please contact your REDCap system admin for these steps. There might be slight differences based on the REDCap version, operating system, etc.

Installation of REDCap-OpenSpecimen plugin

Exact the JAR file from your downloaded zip file.
Login to your OpenSpecimen server and navigate to the plugins directory.
Remove older copy of the REDCap-OpenSpecimen plugin (if any) and copy the current version.
Restart the server.

REDCap Plugins deployment