https://github.com/ctsit/enroll_into_arm

A REDCap feature to allow automatic enrollment immediately after randomization
https://github.com/ctsit/enroll_into_arm

redcap redcap-external-module

Last synced: about 1 month ago
JSON representation

A REDCap feature to allow automatic enrollment immediately after randomization

• Host: GitHub
• URL: https://github.com/ctsit/enroll_into_arm
• Owner: ctsit
• License: apache-2.0
• Created: 2017-09-29T13:48:32.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-11T17:48:12.000Z (over 6 years ago)
• Last Synced: 2023-10-20T19:08:11.636Z (about 1 year ago)
• Topics: redcap, redcap-external-module
• Language: PHP
• Size: 24.4 KB
• Stars: 0
• Watchers: 8
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# Enroll into Arm

A REDCap Module to control the enrollment of subject into a study arm based on the value of a categorical variable. This feature allows automatic enrollment immediately after randomization with the REDCap randomization module.

This feature also defaults subject_id in the affiliated with the given format.

 + "-" +  +  + 

## Prerequisites

- [REDCap Modules](https://github.com/vanderbilt/redcap-external-modules)

## Installation

- Clone this repo into to an `/modules/enroll_into_arm_v1.0.0`

- Go to **Control Center > Manage External Modules** and enable Enroll into arm module.

## Configuration

- In the project go to Manage External Module and enable this module for the project.

- After enabling the module, hit the configure button and add the following json to `Enroll into arm module settings`. This will set the project_settings for that project.

```

{  

   "randomization_field":"rand_group",

   "pad_digits":3,

   "first_name":"first_name",

   "last_name":"last_name",

   "subject_id":"subject_id",

   "randomization_field_values":[  

      {  

         "value":"1",

         "arm_to_enroll":"baseline_arm_2"

      },

      {  

         "value":"2",

         "arm_to_enroll":"baseline_arm_3"

      }

   ]

}

```

## How to use?

- Enable the randomization for a field.

- The name of the field whose value is randomized should be placed under `project_settings->randomized_group`. 

- For construction of subject_id we need first_name, last_name and length of the padded digits to be given, so the field_names for these should be given under json, so that the module automatically picks these values.

- Also the field that stores the subject_id should be placed under `project_settings->subject_id`