Logo

Background

  • Rare Diseases and Interoperability
    • Definitons
    • Further Reading
  • Ontologies & Terminologies
    • Ontologies used in RareLink
    • Further Reading
  • GA4GH Phenopackets
    • Phenopacket Blocks
    • Phenopacket Tools
  • HL7 FHIR
    • FHIR and Rare Diseases (RDs)
    • FHIR Overview - Clinicians
    • FHIR Overview - Developers
    • FHIR Overview - Architects
    • Further Reading
  • RD-CDM
    • RD-CDM Overview
    • Key Success Factors of a Rare Disease Common Data Model
    • Further Reading
  • REDCap
    • REDCap Projects
    • REDCap Instruments
    • REDCap Data Dictionary
    • REDCap API
    • REDCap Ontology Services
    • Further Reading

RareLink Framework

  • RareLink Overview
    • RareLink Framework components
  • RareLink-CDM
    • Contents
    • REDCap Data Dictionary
    • LinkML Schema
    • Rules for REDCap codes and codesystems
    • REDCap Field Annotations
    • RareLink-CDM Instruments
  • RareLink CLI
    • 1. Framework Setup (framework)
    • 2. REDCap Setup (setup)
    • 3. REDCap Tools (redcap)
    • 4. FHIR configuration and pipelines (fhir)
    • 5. Phenopacket Export (phenopackets)

Installation

  • Set up the RareLink Framework
    • Getting Started
    • RareLink Framework CLI config
  • Set up a REDCap Project
    • Steps
    • Next Steps and further reading
    • RareLink CLI Commands
  • Set up the Data Dictionary
    • Installation
    • Separate RareLink-CDM Instruments
    • Extensional RareLink-CDM Instruments
    • Customise the Data Dictionary
  • Set up the REDCap API
    • API Set Up

User Guide

  • Manual Data Capture
    • General Information (please read!)
    • (1) Formal Criteria
    • (2) Personal Information
    • (3) Patient Status
    • (4) Care Pathway
    • (5) Disease
    • (6.1) Genetic Findings
    • (6.2) Phenotypic Features
    • (6.3) Measurements
    • (6.4) Family History
    • (7) Consent
    • (8) Disability
  • Semi-Automatic Import
    • Overview of Components
    • Steps When Importing Data
    • Examples
    • Additional Resources
  • Phenopackets Module
    • Get started
    • RareLink-CDM to Phenopackets
    • RareLink-Phenopacket engine
    • All Command-Line Options
    • Mapping Configuration Structure
    • Advanced Configuration Options
    • Mapping Strategies
    • Best Practices
  • Phenopacket Adapters
    • Multi-Onset Adapter
    • Ontology Routing Adapter
  • FHIR Module
    • Getting started
    • RareLink-CDM FHIR Profiles
    • RareLink-CLI FHIR Commands
    • Docker Commands
    • Importing FHIR to REDCap
  • Develop REDCap Instruments
    • REDCap instrument structure
    • REDCap-inherent rules
    • RareLink obligatory rules
    • RareLink optional rules
  • REDCap Tools
    • API Endpoints

Additional Information

  • Contributing
  • Changelog
    • v2.0.6
    • v2.0.5 (2025-12-12)
    • v2.0.4 (2025-09-25)
    • v2.0.3 (2025-09-24)
    • v2.0.2 (including v2.0.1)
    • v2.0.0
    • v2.0.0.dev1 (Under Development)
    • Previous versions (up to v2.0):
  • FAQ
  • Glossary
  • Acknowlegements
  • License
  • Contact
RareLink REDCap Documentation
  • RareLink Overview
  • View page source

RareLink Overview

Tip

  • Manuscript: RareLink was recently published in npj Genomic Medicine: https://www.nature.com/articles/s41525-025-00534-z

RareLink aims to maximise the utility of REDCap by providing a comprehensive framework designed specifically for rare disease (RD) research and care. At the core of RareLink is this documentation, the RareLink instruments that are based on the RD-CDM, its user guides and the surrounding preconfigured pipelines and software architecture. This framework ensures that data capture is both consistent and compliant with HL7 FHIR and GA4GH Phenopackets, without the need for additional coding or mapping. As a result, RareLink allows researchers and clinicians to collect and process RD data seamlessly within the REDCap environment.

../_images/rarelink_overview.png

Overview of the RareLink framework integrated with a local REDCap instance. The framework comprises the REDCap instruments based on the RD-CDM, the RareLink API, the toFHIR & CDIS module for export and import to HL7 FHIR IPS and Genomic Reporting Resources, and the RareLink-Phenopackets module for direct export to GA4GH Phenopackets. Additionally, the LinkML-based import mapper facilitates data import from tabular databases into REDCap, while the Manual Data Capture Guide assists with the manual data capture of RD-CDM data in a local REDCap project. The framework is also configurable for disease-specific extensions or custom data models.

Note

You will need your own REDCap instance to deploy the RareLink framework. See the Set up a REDCap Project for more information.


RareLink Framework components

../_images/rarelink_core_modules.png

Overview of the five RareLink core RareLink modules.


Semi-Automatic Import

In many Rare Disease specialised centres, registries or hospitals, data is stored in tabular databases (e.g. Excel). RareLink’s Import Mapper that is utilising the Phenopacket Mapper API can be used to convert and import data from these databases into the REDCap RareLink format and your local REDCap project.

Continue here…

  • Guide for the Set up the REDCap API.

  • User guide for Semi-Automatic Import.


Manual Data Capture

RareLink provides a preconfigured data collection sheets based on the RD-CDM and user guides for manual data capture to ensure precision and correctness of data captured. Further, RareLink defines guidelines for developing more specialised REDCap sheets around the RD-CDM so that the data captured can also be processed by our framework to generate FHIR Resources and Phenopackets.

Continue here…

  • Guide to install the Set up the RareLink Framework.

  • Guide to develop the Set up a REDCap Project.

  • User guide for Manual Data Capture.


Local REDCap Project Setup and API

RareLink is designed to be deployed and installed in a local REDCap instance. Using the guidelines provided, or using our preconfigured RareLink-REDCap and setting up the RareLink API, you can ensure that the data captured is compliant with the our framework to generate FHIR Resources and Phenopackets.

Continue here…

  • How to Set up the Data Dictionary.

  • How to deploy and Set up the REDCap API.


RareLink & Phenopackets

RareLink utilises the Phenopacket Mapper to convert the data captured in REDCap into Phenopackets. The RD-CDM and the corresponding RareLink instruments are preconfigured within our GitHub repository to generate Phenopackets automatically.

Continue here…

  • How to set up the Set up the RareLink Framework and the Set up the REDCap API.

  • Guide to Phenopackets Module.

  • Phenopacket Mapper Repository: https://github.com/BIH-CEI/phenopacket_mapper

  • Documentation: https://bih-cei.github.io/phenopacket_mapper/latest/

RareLink & toFHIR

RareLink utilises toFHIR from SRDC to convert the data captured in REDCap into FHIR Resources. The RD-CDM and the corresponding RareLink instruments are preconfigured within our GitHub repository to generate International Patient Summary (IPS) v2.0, Genomoic Reporting v3.0.0, and FHIR v4.0.1-base profile compliant FHIR Resources automatically. Below you can find more information on how to set up the RareLink API and toFHIR module in your local REDCap project to generate FHIR Resources.

Continue here…

  • How to set up the Set up the RareLink Framework and the Set up the REDCap API.

  • Guide to FHIR Module.

  • toFHIR Repository: https://github.com/srdc/tofhirs

  • Website: https://onfhir.io/tofhir/


RareLink & FHIR Import

RareLink provides a detailed guide on how to link a FHIR server and import FHIR Resources into REDCap utilising the REDCap modules Clinical Data Interoperability Services (CDIS). This module must be installed and activated at your local REDCap site by the REDCap administrator. The guide includes a step by step guide on how to import FHIR Resources into REDCap and how to map the FHIR Resources to the RD-CDM.

Continue here..

  • CDIS REDCap: https://projectredcap.org/software/cdis/

  • CDIS Paper: https://doi.org/10.1016/j.jbi.2021.103871

  • User guide for Importing FHIR to REDCap


Previous Next

© Copyright 2025, Berlin Institute of Health - Charité Universitätsmedizin Berlin.

Built with Sphinx using a theme provided by Read the Docs.