-
Notifications
You must be signed in to change notification settings - Fork 174
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[redcap] new module #9474
Draft
regisoc
wants to merge
51
commits into
aces:main
Choose a base branch
from
regisoc:20241020_redcap_module
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
[redcap] new module #9474
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
driusan
reviewed
Nov 18, 2024
maximemulder
added
Project: HBCD
Issue or PR related to the HBCD project
Project: C-BIG
Issue or PR related to the C-BIG project
Difficulty: Complex
PR or issue that require a great effort to implementat, review, or test
Area: Instruments
PR or issue related instruments
Release: SQL patch
PR that contains an SQL patch to apply
labels
Nov 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Area: Instruments
PR or issue related instruments
Difficulty: Complex
PR or issue that require a great effort to implementat, review, or test
Project: C-BIG
Issue or PR related to the C-BIG project
Project: HBCD
Issue or PR related to the HBCD project
Release: SQL patch
PR that contains an SQL patch to apply
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Brief summary of changes (WIP)
This PR adds the REDCap interoperability module.
This module opens an API endpoint to receive notifications from REDCap servers through the use of the
Data Entry Trigger (DET)
. REDCap notifications are parsed and REDCap records are imported into LORIS.If an error happens during this notification handling process, an error is generated in the issue tracker.
The module is imported from HBCD, and even if the core logic is the same, REDCap objects are now their own models.
This version also supports connection to multiple REDCap instances.
Features
The main goal was to replicate HBCD data import process based on
REDCap DET
.redcap2linst
: script to import REDCap forms as LORIS LINST instruments.fetch button
: UI button on instrument panel to trigger data import (could be done later)State
Testing instructions (if applicable)
Notification process:
config.xml
following the structure given inRB/config.xml
file.Front-end > Admin > Configuration > REDCap > redcap_importable_instrument
./redcap/notifications
) to simulate the reception of a DET notification. The payload should be the following (seeredcap/notifications/redcapnotification.class.inc
):REDCap LINST instrument process:
tools/redcap2linst.php
usage.Link(s) to related issue(s)
Links to related PRs