- Open Access
Second generation registry framework
Source Code for Biology and Medicine volume 9, Article number: 14 (2014)
Information management systems are essential to capture data be it for public health and human disease, sustainable agriculture, or plant and animal biosecurity. In public health, the term patient registry is often used to describe information management systems that are used to record and track phenotypic data of patients. Appropriate design, implementation and deployment of patient registries enables rapid decision making and ongoing data mining ultimately leading to improved patient outcomes. A major bottleneck encountered is the static nature of these registries. That is, software developers are required to work with stakeholders to determine requirements, design the system, implement the required data fields and functionality for each patient registry. Additionally, software developer time is required for ongoing maintenance and customisation. It is desirable to deploy a sophisticated registry framework that can allow scientists and registry curators possessing standard computing skills to dynamically construct a complete patient registry from scratch and customise it for their specific needs with little or no need to engage a software developer at any stage.
This paper introduces our second generation open source registry framework which builds on our previous rare disease registry framework (RDRF). This second generation RDRF is a new approach as it empowers registry administrators to construct one or more patient registries without software developer effort. New data elements for a diverse range of phenotypic and genotypic measurements can be defined at any time. Defined data elements can then be utilised in any of the created registries. Fine grained, multi-level user and workgroup access can be applied to each data element to ensure appropriate access and data privacy. We introduce the concept of derived data elements to assist the data element standards communities on how they might be best categorised.
We introduce the second generation RDRF that enables the user-driven dynamic creation of patient registries. We believe this second generation RDRF is a novel approach to patient registry design, implementation and deployment and a significant advance on existing registry systems.
The need for information systems, or registries in scientific disciplines is ubiquitous. For instance, in human rare disease [1–4] as well as plant and animal biosecurity [5, 6]. In the field of human rare diseases alone, registries are used for clinical trial recruitment, surveillance, patient contact, natural disease history and longitudinal patient phenotyping. Previously, a first generation rare disease registry framework (RDRF), was developed to simplify the development and deployment of rare disease registries as there are over 6000 human rare conditions [3, 4]. This framework introduced a modular design to rare disease registry development to reduce the amount of software developer time required to develop a new registry and enable the ability to incorporate new functionality efficiently. The RDRF introduced concepts including multi-level secure access, workgroups and simplifying the customisation of modules to enable reuse of component from one rare disease registry to the next across a range of registry requirements. The RDRF has been successfully deployed for a number of diseases both nationally and internationally [3, 7].
However, within the RDRF there are a number of bottlenecks. For instance, for every new registry, data elements must be implemented at a programmatic level. That is, the registry schema and data elements are static. This leads to a number of limitations, for instance, i) while software developer code might be efficiently shared between registry implementations via modules, there is no simple, systematic way to link them at the user level, except through import/export functionality - a lower form of interoperability ; and ii) there is no ability to import (computer readable) standardised, predefined data elements (e.g. data elements defined within the Neurological Disorders and Stroke Common Data Element Project ). Software developer effort is required at every level of development and customisation. While the first generation RDRF is suitable for a number of use cases, it is recognised that community-wide ease of uptake without the need for software developer time is an important requirement that must be met.
It is not scalable for a software developer to be intimately involved in every single registry development and deployment. For instance, in a rare disease context, there are over 6000 rare conditions that need to be captured in multiple registries, in multiple countries, regions or jurisdictions. With the current state of registry development, there is no intuitive way to aggregate disease registries nor is it possible to easily reuse a data element (DE) created in one registry, into another. In a desirable scenario, for ten different national/international rare disease registries it should be possible to define a single Date of Birth (DOB) DE that can be reused in each of the ten registries. The advantages of this level of abstraction can be extended further. If a DE such as the DOB field is defined in a standardised template (e.g. ) with a unique identifier, then it would be feasible to dynamically import these standard DEs into a registry. In addition, in order to capture a new measurement, a new DE could be defined and dynamically added to a production registry well after the registry has been created.
In this paper, we describe this significant advance of the RDRF over static registry development in general. We outline the features of this second generation registry framework that enables non-software developers to dynamically create and administer patient registries.
Currently RDRF is deployed to the CentOS (http://www.centos.org/) Linux operating system, using Apache (http://httpd.apache.org/) as a web server. Deploying using other operating systems and Linux distributions is possible, however currently only CentOS is tested and supported. A YUM (http://yum.baseurl.org/) repository and RPM (http://rpm.org/) for installation of the framework are also provided for CentOS 6 (http://rare-disease-registry-framework.readthedocs.org/).
We describe a highly dynamic web framework for the creation of patient registries with no extra software development. That is, users of the system do not need to be software developers to construct and deploy registries from scratch. To enable this, we exploited the metaprogramming features exposed by Python and the schema-less storage facilities provided by MongoDB.
Python allows creation of classes as first class citizens. By constructing classes at runtime, the RDRF is able to construct complex dynamic forms based on user specifications. Critically, no recompilation or code changes are required to incorporate new fields or form elements. Changes to presentation elements (widgets) or validation logic can all be made at runtime.
A relational database is too restrictive to enable runtime modification of fields. Instead, a schema-less data store, MongoDB, was used to allow storage of dynamically defined data in the RDRF. MongoDB was chosen because it is an industry recognised schema-less data store with a powerful, well-documented query API. MongoDB stores all data in the form of “collections”, which are essentially lists of object dictionaries. Each DE captured by forms within a registry is stored as a single key value pair in one such dictionary. The key includes the patient identifier, the DE code and some additional bookkeeping to encode the registry form structure. To simplify the implementation of permissions, each user-defined registry is isolated in its own MongoDB data collection.
Metadata about each DE, including its data type, is stored as part of the DE definition in the relational SQL database. In this way, the relational SQL database and the NoSQL database provide a clean separation between static field-definition features (SQL) and the dynamic domain-level features (NoSQL).
Creating multiple patient registries
Figure 1 provides a screen capture of the registry creation screen. A user with appropriate credentials can use the web-based administration interface to create one or more registries.
Data element (DE) definition and reuse
Users can define data elements (DEs) that can be shared by all registries created within the framework. There are a number of attributes that can be set for DEs. There are multiple data types: integer, float, string, date, file, that can be used for attributes within each DE. Validation rules (e.g. minimum and maximum for numeric fields) can be defined and pattern validation can be defined for textual fields (e.g. credit-card number pattern consisting of four sets of four digits separated by a space). For more sophisticated DEs, a DE can incorporate Permitted Value Groups (PVG). For example, a PVG might be called, Size with the permissible values: large, medium, small. This PVG can then be applied to any DEs that requires the Size PVG. Figure 2 displays a screen capture of the DE definition page.
Derived data elements (DDEs)
Importing and exporting data elements
It is possible to import and export DEs via a YAML specification file. By using YAML, a single human-readable file definition of a registry can be exported which can then be version-controlled and used for sharing with other research communities.
A catalogue of all the DE defined within a patient registry is also exportable.
Registries often require documents to be uploaded into the system. Such forms include signed patient consent forms in a human health context or an export certification form in a biosecurity context. This can be simply achieved within the RDRF. Files can be uploaded and downloaded using the File fields after creating the specific file upload DE.
A demonstration rare disease registry using the second generation RDRF is available for testing (https://ccgapps.com.au/demo-rdrf/). The demonstration system allows the creation of new registries, modification of existing ones, creation of new data elements and so forth. The demonstration system has multiple accounts to allow users to test all levels of access and functionality (for example, login: admin, password: admin; login: curator, password: curator; login: genetic, password: genetic; and login: clinical, password: clinical). A screenshot of a patient questionnaire from the demonstration registry is shown in Figure 4.
Discussion and conclusion
In this paper, we introduce significant enhancement to our patient registry framework (RDRF) which now allows the dynamic creation of new registries with little or no software development. This addresses the critical bottlenecks of community uptake and wider applicability. RDRF could also be used in a surveillance context or in clinical studies where there is an initial need to establish a registry with a given set of data elements (DEs) but will need to be later enriched with new DEs as a result of additional phenotypical measurements that need to be captured. Importantly, DEs are able to be created once and reused (shared) in multiple registries and can be one of multiple data types. From a systems perspective, we contend that shared DEs (SDEs) will enable higher levels of interoperability  that can facilitate ease of sharing and extensive data mining of patient data across jurisdictional boundaries - another significant bottleneck in patient disease registries. We introduce the concept of a derived DE (DDE). A DDE can be derived from one or more DEs which means it is possible to actualise efforts emanating from efforts to define a DE ontology (DEO). Current data standards for DEs (such as ) could be revised to reflect that the unique identifier used for any given DDEs, references the identifiers of DEs from which the DDE is derived.
From a technological perspective, the feature being exploited in the Python programming language is the ability to create classes dynamically. Typically most web applications define classes statically, whereas RDRF is dynamically constructing these classes at run time from the DE definitions, which act as the specification. We believe RDRF will have broader applicability and can now be used in a wide range of disease and surveillance contexts for human, animal, plant health or in a biosecurity context. RDRF will enable decision makers to establish registries thereby ensuring personal electronic records can be ‘born digital’. As RDRF now employs YAML, a single human-readable file definition of a registry can be exported. This means that it will be possible to version-control a registry for future sharing with other research communities or customising for specific needs.
In future releases we plan a number of enhancements, including: the definition of a DE specification format (DESF); ability to apply rules to the DEs to enable knowledge capture; and import outputs from a next generation sequencing experiment which includes both the variant call format (VCF) file as well as the analysis workflow audit trail .
Availability and requirements
Project name: RDRF
Project home page: https://bitbucket.org/ccgmurdoch/rdrf
Operating system(s): Linux (CentOS 6 tested)
Programming language: Python
Other requirements: PostgreSQL, MongoDB, Apache (including mod_wsgi)
License: GNU GPL v3
Any restrictions to use by non-academics: Yes
Matthew Bellgard: Professor Matthew Bellgard (BSc Hons, PhD in Computer Science) is Murdoch University’s Bioinformatics Chair and the Director of the Western Australian State Government Centre of Excellence, the Centre for Comparative Genomics (CCG). His scientific work has resulted in developments in the areas of pairwise sequence alignment and artificial intelligence, early detection of base composition differences in closely related bacterial species, whole genome sequence analysis and advances in the development of web-based integrated systems utilising high performance computing.
Lee Render: BSc Physics UWA, BA Philosophy (Hons) UWA. Has over ten years industry experience in software development with experience in .NET and Java. He has had direct experience in designing, developing and maintaining bioinformatics workflow systems. Current focus on Python software development.
Maciej Radochonski: Maciej Radochonski completed a MSc Eng in Applied Computer Engineering at Wroclaw University of Technology, Poland and a MSc in Information and Communication Technology at The University of Notre Dame Australia. Maciej has nearly 8 years experience in software development using Java and related technologies. Current focus on Python software development.
Adam Hunter: Adam Hunter completed a BSc Honours in Computer Science at Murdoch University. Adam has over 10 years experience in ICT including software development in C and Java. He leads the CCG software development and infrastructure team. Current areas of focus include continuous integration, agile programming and cloud computing.
Data element ontology
Defined data element
Data element specification format
Shared data elements
Rare disease registry framework.
Rubinstein YR, Groft SC, Bartek R, Brown K, Christensen RA, Collier E, Farber A, Farmer J, Ferguson JH, Forrest CB, Lockhart NC, McCurdy KR, Moore H, Pollen GB, Richesson R, Miller VR, Hull S, Vaught J: Creating a global rare disease patient registry linked to a rare diseases biorepository database: Rare Disease-HUB (RD-HUB). Contemp Clin Trials. 2010, 31 (5): 394-404. 10.1016/j.cct.2010.06.007.
Series OR: Disease Registries in Europe. 2013, Available from: http://www.orpha.net/orphacom/cahiers/docs/GB/Registries.pdf
Bellgard MI, Macgregor A, Janon F, Harvey A, O'Leary P, Hunter A, Dawkins H: A modular approach to disease registry design: successful adoption of an internet-based rare disease registry. Hum Mutat. 2012, 33 (10): E2356-E2366. 10.1002/humu.22154.
Bellgard M, Beroud C, Parkinson K, Harris T, Ayme S, Baynam G, Weeramanthri T, Dawkins H, Hunter A: Dispelling myths about rare disease registry system development. Source Code Biol Med. 2013, 8 (1): 21-10.1186/1751-0473-8-21.
Bellgard MI, Bellgard SE: A Bioinformatics Framework for plant pathologists to deliver global food security outcomes. Austral Plant Pathol. 2012, 41 (2): 113-124. 10.1007/s13313-011-0099-x.
IPPC ISPM 35: Systems Approach for Pest Risk Management of Fruit Flies (Tephritidae). 2012, 10-Available from: http://www.fao.org/docrep/016/k6768e/k6768e.pdf
Rodrigues M, Hammond-Tooke G, Kidd A, Love D, Patel R, Dawkins H, Bellgard M, Roxburgh R: The New Zealand Neuromuscular Disease Registry. J Clin Neurosci. 2012, 19 (12): 1749-1750. 10.1016/j.jocn.2012.04.008.
Grinnon ST, Miller K, Marler JR, Lu Y, Stout A, Odenkirchen J, Kunitz S: National Institute of Neurological Disorders and Stroke Common Data Element Project - approach and methods. Clin Trials. 2012, 9 (3): 322-329. 10.1177/1740774512438980.
Hunter AA, Macgregor AB, Szabo TO, Wellington CA, Bellgard MI: Yabi: An online research environment for grid, high performance and cloud computing. Source Code Biol Med. 2012, 7 (1): 1-10.1186/1751-0473-7-1.
The authors received funding from the Australian National Health and Medical Research Council (APP1055319), EU FP7 Project (HEALTH.2012.2.1.1-1-C): RD Connect: An integrated platform connecting databases, registries, biobanks and clinical bioinformatics for rare disease research, and the Office of Population Health Genomics, Department of Health, Western Australia. The authors wish to acknowledge their involvement in the International Rare Disease Research Consortium. The authors also wish to acknowledge John McCooke for providing valuable feedback on the demonstration RDRF system deployed.
The authors declare that they have no competing interests.
MB and AH devised original concept design. Software architectural design LR, AH, MR. Wrote manuscript: MB, AH, LR. All authors read and approved the final manuscript.
Authors’ original submitted files for images
Below are the links to the authors’ original submitted files for images.
Rights and permissions
This article is published under license to BioMed Central Ltd. This is an Open Access article distributed under the terms of the Creative Commons Attribution License (http://creativecommons.org/licenses/by/4.0), which permits unrestricted use, distribution, and reproduction in any medium, provided the original work is properly credited. The Creative Commons Public Domain Dedication waiver (http://creativecommons.org/publicdomain/zero/1.0/) applies to the data made available in this article, unless otherwise stated.
About this article
Cite this article
Bellgard, M.I., Render, L., Radochonski, M. et al. Second generation registry framework. Source Code Biol Med 9, 14 (2014). https://doi.org/10.1186/1751-0473-9-14
- Patient registry
- Born digital
- Data element