Difference between revisions of "Lookup Data"

From ECRIN-MDR Wiki
Jump to navigation Jump to search
(Created page with "===Controlled Terminology=== Many of the data fields in the MDR system are categorised, i.e. they are constrained to hold one of a predefined set of possible values. <br> For...")
 
(Structure of Look Up tables)
Line 14: Line 14:
 
* A string ''name'' field, with the short name of the category, as it would appear – for instance – in a dropdown box that displayed the alternatives available.
 
* A string ''name'' field, with the short name of the category, as it would appear – for instance – in a dropdown box that displayed the alternatives available.
 
* A text ''description'' field, that provides, when necessary, a brief explanation of what the category meant.
 
* A text ''description'' field, that provides, when necessary, a brief explanation of what the category meant.
 +
*      A boolean ''use_in_data_entry'' field, that indicates if the field should be used in a data entry context, as opposed to a data harvesting context.
 
* An integer ''list_order'' field, which allows the default order in a display or report (normally that of the id, as the primary key) to be over-ridden, by ordering the records according to the value of this field.
 
* An integer ''list_order'' field, which allows the default order in a display or report (normally that of the id, as the primary key) to be over-ridden, by ordering the records according to the value of this field.
 
A few look up tables have one or two additional fields but the great majority follow the pattern above.  
 
A few look up tables have one or two additional fields but the great majority follow the pattern above.  
Line 25: Line 26:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! id !! name !! description !! list_order !! source !! date_added  
+
! id !! name !! description !! use_in_data_entry !! list_order !! source !! date_added  
 
|-
 
|-
| 0|| Not yet known|| Dummy value supplied by default on entity creation.|| 99 || ECRIN || 2019-02-08
+
| 0|| Not yet known|| Dummy value supplied by default on entity creation.|| false || 99 || ECRIN || 2019-02-08
 
|-
 
|-
| 11|| Interventional|| A clinical trial.|| 10|| ClinicalTrials.gov || 2019-02-08
+
| 11|| Interventional|| A clinical trial.|| true || 10|| ClinicalTrials.gov || 2019-02-08
 
|-
 
|-
| 12 || Observational|| Any form of non-interventional research.|| 20|| ClinicalTrials.gov || 2019-02-08
+
| 12 || Observational|| Any form of non-interventional research.|| true || 20|| ClinicalTrials.gov || 2019-02-08
 
|-
 
|-
| 13|| Observational Patient Registry|| Collecting data for a designated registry.|| 30|| ClinicalTrials.gov || 2019-02-08
+
| 13|| Observational Patient Registry|| Collecting data for a designated registry.|| true || 30|| ClinicalTrials.gov || 2019-02-08
 
|-
 
|-
| 14|| Expanded access|| Off label usage of a new product for individuals.|| 40|| ClinicalTrials.gov || 2019-02-08
+
| 14|| Expanded access|| Off label usage of a new product for individuals.|| true || 40|| ClinicalTrials.gov || 2019-02-08
 
|-
 
|-
| 15|| Funded programme|| With a single or linked series of grants.|| 50|| ClinicalTrials.gov || 2019-02-08
+
| 15|| Funded programme|| With a single or linked series of grants.|| false|| 50|| ClinicalTrials.gov || 2019-02-08
 
|}
 
|}
  

Revision as of 11:41, 21 April 2022

Controlled Terminology

Many of the data fields in the MDR system are categorised, i.e. they are constrained to hold one of a predefined set of possible values.
For example, a clinical study may fall into one of several different main ‘types’, according to the broad methodology used:

  • Interventional
  • Observational
  • Observational [Patient Registry]
  • Expanded access
  • Funded programme

Although clinical studies are usually categorised in similar ways, different systems can use different terms for those categories. Using the MDR’s controlled terminology, studies labelled as ‘clinical trial’, ‘randomised trial’, or ‘active intervention’ would all be mapped to a study type of ‘Interventional’, while other studies, described variously as ‘off-label’, ‘compassionate use’, or ‘pre-licence’, would all be mapped to ‘Expanded Access’. The options available for any categorised data item are stored in a 'look up' table.

Structure of Look Up tables

The MDR system uses a collection of these ‘look up’ tables. In the context of a user interface, each lookup table would often be used as the source of a dropdown or list box that displayed the categories for search or filtering purposes. Each look up table lists the options available for that data field, and almost all have a core common structure:

  • An integer id field, that provides a key for each option. The database only has to store the id to represent the category being used, making storage much more efficient.
  • A string name field, with the short name of the category, as it would appear – for instance – in a dropdown box that displayed the alternatives available.
  • A text description field, that provides, when necessary, a brief explanation of what the category meant.
  • A boolean use_in_data_entry field, that indicates if the field should be used in a data entry context, as opposed to a data harvesting context.
  • An integer list_order field, which allows the default order in a display or report (normally that of the id, as the primary key) to be over-ridden, by ordering the records according to the value of this field.

A few look up tables have one or two additional fields but the great majority follow the pattern above.
The categories used are normally as already exist within DataCite or other key systems, augmented if necessary by ECRIN to better cover the full range of categories required for clinical research data objects. For instance the listed study types are taken from the study type classification found within the ClinicalTrials.gov trials registry. The lookup tables contain two additional ‘audit’ field:

  • A string source field, denoting the system from which the term was originally taken. Terms created by the MDR team are labelled as ‘ECRIN’
  • A date date_added field, that indicates the date a category was agreed as being required by the MDR system (though full implementation may be later). If a term has been proposed but not yet agreed this date is null.

The study_types table, below, illustrates how this structure works in the case of study categories.

id name description use_in_data_entry list_order source date_added
0 Not yet known Dummy value supplied by default on entity creation. false 99 ECRIN 2019-02-08
11 Interventional A clinical trial. true 10 ClinicalTrials.gov 2019-02-08
12 Observational Any form of non-interventional research. true 20 ClinicalTrials.gov 2019-02-08
13 Observational Patient Registry Collecting data for a designated registry. true 30 ClinicalTrials.gov 2019-02-08
14 Expanded access Off label usage of a new product for individuals. true 40 ClinicalTrials.gov 2019-02-08
15 Funded programme With a single or linked series of grants. false 50 ClinicalTrials.gov 2019-02-08

Listing of Look Up tables

At present the MDR system contains 29 look up tables, with most indicating that they refer to categorised fields by their name, usually <something>_types, occasionally _codes, categories or _classes.
Details on each can be found by following the links listed below.