Required metadata needed for the GWDM
+Associated identifier (number) that is the BigInt key in our SQL database for the dataset version associated with this metadata
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gateway Identifier | +False | +False | +True | +['str'] | +
A unique persistent identifier for the metadata version. This is a 128-bit unique identifiers, as 32 hexadecimal digits separated by hyphens
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gateway Persistent Identifier | +False | +False | +True | +['str'] | +
Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +['str'] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +False | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] | +
Examples:
+Summary of metadata describing key pieces of information.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["TwoHundredFiftyFiveCharacters[{'maxLength': 255, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+A shorter descriptive title of the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Short Title | +False | +True | +True | +["ShortTitle[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +True | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +False | +True | +["LongAbstractText[{'anyOf': [{'maxLength': 5000, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]"] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Keywords that have been filtered and limited
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +['EmailStr', 'null'] | +
Examples:
+Placeholder for dataset type"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Longer description of the dataset in detail
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+The organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member)/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Publisher name | +False | +True | +True | +['Name[{}]', 'null'] | +
Examples:
+The link to an ID somewhere in the gateway where more information on the publisher can be retrieved."
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Publisher gateway id | +False | +True | +False | +['str', 'null'] | +
This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Availability of physical samples associated with the dataset. If samples are available, please indicate the types of samples that are available. More than one type may be provided. If sample are not yet available, please provide “AVAILABILITY TO BE CONFIRMED”. If samples are not available, then please provide “NOT AVAILABLE”.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical Sample Availability | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+None
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
None
+The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Periodicity | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citation Requirements' | +False | +True | +False | +["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
This section includes information about data access
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+Code value of the ontology vocabulary encoding
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+What the vocabulary conforms to.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Conforms To | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Language code(s) of the language of the dataset metadata and underlying data is made available.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Language Code(s) | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Format(s) the dataset can be made available in
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Format | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Metadata for various linkages with datasets and other gateway entities
+??
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is Generated Using | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+??
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Uses | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced.',
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is Reference in | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
URL of any analysis tools or models that have been created for this dataset and are available for further use
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset Linkage copied over from
+Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+If the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is PartOf | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset is a member of XXX(?)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is MemberOf | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Links to other datasets.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide the keystone paper associated with the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Descriptions of all tables and data elements that can be included in the dataset
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
A description of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Description' | +False | +True | +False | +['str', 'null'] | +
A list of columns contained within a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
values in a dataset
+Unique value in a column .
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Name | +False | +False | +True | +['Name[{}]'] | +
A description of a unique value in a column.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Description | +False | +True | +False | +['str', 'null'] | +
The frequency of occurrance of a value in a column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Frequency | +False | +True | +False | +['int', 'null'] | +
summary.version : new string field to record the metadata version, this was accidentaly dropped in the previous version of the modelsummary.populationSize: new integer field to record the population size of the dataset/cohort in the summary fieldsummary.datasetSubType: new string field to be used with summary.datasetType to record the type of datasetsummary.publisher : this field is now of type Organisation, it addssummary.publisher.publisherName --> summary.publisher.namesummary.publisher.publisherGatewayId --> summary.publisher.gatewayIdsummary.publisher.rorId (Optional) ror.orgcoverage.physicalSampleAvailability --> coverage.biologicalsamplescoverage.gendercoverage.psychologicalcoverage.physicalcoverage.anthropometriccoverage.lifestylecoverage.socioeconomictissuesSampleCollection.idtissuesSampleCollection.dataCategoriestissuesSampleCollection.materialTypetissuesSampleCollection.accessConditionstissuesSampleCollection.collectionTypetissuesSampleCollection.diseasetissuesSampleCollection.storageTemperaturetissuesSampleCollection.sampleAgeRangetissuesSampleCollection.tissueSampleMetadata.idtissuesSampleCollection.tissueSampleMetadata.sampleDonor.idtissuesSampleCollection.tissueSampleMetadata.sampleDonor.sextissuesSampleCollection.tissueSampleMetadata.sampleDonor.birthDatetissuesSampleCollection.tissueSampleMetadata.sampleDonor.dataCategoriestissuesSampleCollection.tissueSampleMetadata.sampleTypetissuesSampleCollection.tissueSampleMetadata.storageTemperaturetissuesSampleCollection.tissueSampleMetadata.creationDatetissuesSampleCollection.tissueSampleMetadata.anatomicalSiteOntologyCodetissuesSampleCollection.tissueSampleMetadata.anatomicalSiteOntologyDescriptiontissuesSampleCollection.tissueSampleMetadata.anatomicalSiteFreeTexttissuesSampleCollection.tissueSampleMetadata.sampleContentDiagnosistissuesSampleCollection.tissueSampleMetadata.useRestrictionsRequired metadata needed for the GWDM
+Associated identifier (number) that is the BigInt key in our SQL database for the dataset version associated with this metadata
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gateway Identifier | +False | +False | +True | +['str'] | +
A unique persistent identifier for the metadata version. This is a 128-bit unique identifiers, as 32 hexadecimal digits separated by hyphens
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gateway Persistent Identifier | +False | +False | +True | +['str'] | +
Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +['str'] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +False | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] | +
Examples:
+Dataset metadata version
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Version | +False | +False | +True | +['str'] | +
Examples:
+Summary of metadata describing key pieces of information.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["TwoHundredFiftyFiveCharacters[{'maxLength': 255, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+A shorter descriptive title of the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Short Title | +False | +True | +True | +["ShortTitle[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +True | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +False | +True | +["LongAbstractText[{'anyOf': [{'maxLength': 5000, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]"] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Keywords that have been filtered and limited
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +['EmailStr', 'null'] | +
Examples:
+Placeholder for dataset type"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Longer description of the dataset in detail
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +True | +True | +['Name[{}]', 'null'] | +
Identifier on the gateway
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Gateway Identifier | +False | +True | +False | +['str', 'null'] | +
The Research Organization Registry (ROR) for the organisation, if applicable
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Research Organization Registry Identifier | +False | +True | +False | +['str', 'null'] | +
Summary population size of the cohort
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Population size | +False | +True | +False | +['int', 'null'] | +
Placeholder for dataset sub-type
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Sub-type | +False | +True | +False | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
Cohort description: Male, Female, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gender | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Blood, Saliva, Urine, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Biological Samples | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Mental health, Cognitive function
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Psychological | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Cardiovascular, Respiratory, Musculoskeletal, Hearing and Vision, Reproductive
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Height, Weight, Waist circumference, Hip circumference, Blood pressure
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anthropometric | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort lifestyle habits: Smoking, Physical activity, Dietary habits, Alcohol
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Lifestyle | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Occupation, Family circumstances, Housing, Education, Ethnic group, Marital status, Social support
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Socio-economic | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+None
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
None
+The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Periodicity | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +True | +True | +['Name[{}]', 'null'] | +
Identifier on the gateway
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Gateway Identifier | +False | +True | +False | +['str', 'null'] | +
The Research Organization Registry (ROR) for the organisation, if applicable
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Research Organization Registry Identifier | +False | +True | +False | +['str', 'null'] | +
This section includes information about data access
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+Code value of the ontology vocabulary encoding
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+What the vocabulary conforms to.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Conforms To | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Language code(s) of the language of the dataset metadata and underlying data is made available.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Language Code(s) | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Format(s) the dataset can be made available in
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Format | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Metadata for various linkages with datasets and other gateway entities
+??
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is Generated Using | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+??
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Uses | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced.',
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is Reference in | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
URL of any analysis tools or models that have been created for this dataset and are available for further use
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset Linkage copied over from
+Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+If the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is PartOf | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset is a member of XXX(?)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is MemberOf | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Links to other datasets.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide the keystone paper associated with the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Descriptions of all tables and data elements that can be included in the dataset
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
A description of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Description' | +False | +True | +False | +['str', 'null'] | +
A list of columns contained within a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
values in a dataset
+Unique value in a column .
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Name | +False | +False | +True | +['Name[{}]'] | +
A description of a unique value in a column.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Description | +False | +True | +False | +['str', 'null'] | +
The frequency of occurrance of a value in a column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Frequency | +False | +True | +False | +['int', 'null'] | +
metedata for tissue samples
+ID of the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| ID | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The type of data that is associated with the samples in the study. Can be several values MIABIS-2.0-13
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Categories | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes. Can be several values MIABIS-2.0-14
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Material Type | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Access conditions for the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Conditions | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The type of the sample collection. Can be several values MIABIS-2.0-16
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Type | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Disease associated with the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disease | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Storage temperature of the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Storage Temperature | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Age range of the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sample Age Range | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Metadata related to the tissue sample
+ID of the tissue sample metadata
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata ID | +False | +True | +False | +['str', 'null'] | +
Information about the sample donor
+ID of the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor ID | +False | +True | +False | +['str', 'null'] | +
Sex of the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor Sex | +False | +True | +False | +['str', 'null'] | +
Date of birth of the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor birth date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Data categories related to the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor Data Categories | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Type of the tissue sample
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sample Type | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Storage temperature of the tissue sample
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Storage Temperature | +False | +True | +False | +['str', 'null'] | +
Date when the tissue sample metadata was created
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Creation Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Ontology code for the anatomical site, this code must match an ICD-0-3 format
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Ontology Code | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Ontology description for the anatomical site
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Ontology Description | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Free text describing the anatomical site
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Free Text | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Diagnosis related to the sample content
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sample Content Diagnosis | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Restrictions on the use of the tissue sample
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Use Restrictions | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
linkage.syntheticDataWebLink: new field for storing internal/external links to synthetic data resources related to the datasetaccessibility.access.accessServiceCategory: new field for categorising if a dataset access is direct, TRE/SDE, etc.Required metadata needed for the GWDM
+Associated identifier (number) that is the BigInt key in our SQL database for the dataset version associated with this metadata
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gateway Identifier | +False | +False | +True | +['str'] | +
A unique persistent identifier for the metadata version. This is a 128-bit unique identifiers, as 32 hexadecimal digits separated by hyphens
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gateway Persistent Identifier | +False | +False | +True | +['str'] | +
Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +['str'] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +False | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] | +
Examples:
+Dataset metadata version
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Version | +False | +False | +True | +['str'] | +
Examples:
+Summary of metadata describing key pieces of information.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["TwoHundredFiftyFiveCharacters[{'maxLength': 255, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+A shorter descriptive title of the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Short Title | +False | +True | +True | +["ShortTitle[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +True | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +False | +True | +["LongAbstractText[{'anyOf': [{'maxLength': 5000, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]"] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Keywords that have been filtered and limited
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +['EmailStr', 'null'] | +
Examples:
+Placeholder for dataset type"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Longer description of the dataset in detail
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +True | +True | +['Name[{}]', 'null'] | +
Identifier on the gateway
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Gateway Identifier | +False | +True | +False | +['str', 'null'] | +
The Research Organization Registry (ROR) for the organisation, if applicable
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Research Organization Registry Identifier | +False | +True | +False | +['str', 'null'] | +
Summary population size of the cohort
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Population size | +False | +True | +False | +['int', 'null'] | +
Placeholder for dataset sub-type
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Sub-type | +False | +True | +False | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
Cohort description: Male, Female, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gender | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Blood, Saliva, Urine, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Biological Samples | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Mental health, Cognitive function
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Psychological | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Cardiovascular, Respiratory, Musculoskeletal, Hearing and Vision, Reproductive
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Height, Weight, Waist circumference, Hip circumference, Blood pressure
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anthropometric | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort lifestyle habits: Smoking, Physical activity, Dietary habits, Alcohol
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Lifestyle | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Cohort description: Occupation, Family circumstances, Housing, Education, Ethnic group, Marital status, Social support
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Socio-economic | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+None
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
None
+The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Periodicity | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Accessibility information.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +True | +True | +['Name[{}]', 'null'] | +
Identifier on the gateway
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Gateway Identifier | +False | +True | +False | +['str', 'null'] | +
The Research Organization Registry (ROR) for the organisation, if applicable
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Research Organization Registry Identifier | +False | +True | +False | +['str', 'null'] | +
This section includes information about data access
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Where access to data come from: TRE/SED, direct access, open acccess, varies based on project.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access/governance requirements | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+Code value of the ontology vocabulary encoding
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+What the vocabulary conforms to.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Conforms To | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Language code(s) of the language of the dataset metadata and underlying data is made available.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Language Code(s) | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Format(s) the dataset can be made available in
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Format | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Linkage and enrichment.
+??
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is Generated Using | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+??
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Uses | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced.',
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is Reference in | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
URL of any analysis tools or models that have been created for this dataset and are available for further use
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset Linkage copied over from
+Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+If the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is PartOf | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset is a member of XXX(?)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Is MemberOf | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Links to other datasets.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide the keystone paper associated with the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Links to locations of information and or raw downloads of synthetic data associated with this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Synthetic Data Web Links | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Descriptions of all tables and data elements that can be included in the dataset
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
A description of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Description' | +False | +True | +False | +['str', 'null'] | +
A list of columns contained within a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
values in a dataset
+Unique value in a column .
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Name | +False | +False | +True | +['Name[{}]'] | +
A description of a unique value in a column.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Description | +False | +True | +False | +['str', 'null'] | +
The frequency of occurrance of a value in a column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Value Frequency | +False | +True | +False | +['int', 'null'] | +
metedata for tissue samples
+ID of the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| ID | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The type of data that is associated with the samples in the study. Can be several values MIABIS-2.0-13
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Categories | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes. Can be several values MIABIS-2.0-14
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Material Type | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Access conditions for the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Conditions | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The type of the sample collection. Can be several values MIABIS-2.0-16
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Type | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Disease associated with the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disease | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Storage temperature of the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Storage Temperature | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Age range of the tissue sample collection
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sample Age Range | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Metadata related to the tissue sample
+ID of the tissue sample metadata
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata ID | +False | +True | +False | +['str', 'null'] | +
Information about the sample donor
+ID of the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor ID | +False | +True | +False | +['str', 'null'] | +
Sex of the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor Sex | +False | +True | +False | +['str', 'null'] | +
Date of birth of the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor birth date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Data categories related to the sample donor
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Donor Data Categories | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Type of the tissue sample
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sample Type | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Storage temperature of the tissue sample
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Storage Temperature | +False | +True | +False | +['str', 'null'] | +
Date when the tissue sample metadata was created
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Creation Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Ontology code for the anatomical site, this code must match an ICD-0-3 format
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Ontology Code | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Ontology description for the anatomical site
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Ontology Description | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Free text describing the anatomical site
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Free Text | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Diagnosis related to the sample content
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sample Content Diagnosis | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Restrictions on the use of the tissue sample
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Use Restrictions | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
System dataset identifier
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset identifier | +False | +True | +True | +["Uuidv4[{'maxLength': 36, 'minLength': 36, 'pattern': '^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$', 'type': 'string'}]", "Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset metadata version
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +True | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
Summary of metadata describing key pieces of information.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +True | +True | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+Please provide a Grid.ac identifier (see https://www.grid.ac/institutes) for your organisation. If your organisation does not have a Grid.ac identifier please use the “suggest and institute” function here: https://www.grid.ac/institutes#
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Identifier | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Please provide a logo associated with the Gateway Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Logo | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a URL that describes the organisation.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Organisation contact point(s)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +
Please indicate if the organisation is an Alliance Member or a Hub.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Membership | +False | +True | +False | +["MemberOf['HUB','ALLIANCE','OTHER','NCS']", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +
Examples:
+Alternate dataset identifiers or local identifiers
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Alternate dataset identifiers | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +
DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards. Organisations are required to confirm that they have permission to distribute any additional media.
+A free-text description of the dataset. Gateway Feature: Keywords and text may be extracted out of the description and index for search
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question. The following formats will be accepted .jpg, .png or .svg, .pdf, .xslx or .docx. Note: media asset can be hosted by the organisation or uploaded using the onboarding portal.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Examples:
+Please complete only if the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Group | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +
Examples:
+This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Examples:
+Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
Availability of physical samples associated with the dataset. If samples are available, please indicate the types of samples that are available. More than one type may be provided. If sample are not yet available, please provide “AVAILABILITY TO BE CONFIRMED”. If samples are not available, then please provide “NOT AVAILABLE”.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical Sample Availability | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List', 'null'] | +
Examples:
+If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+Coverate by origin (geographical and situations)
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]', 'null'] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Source.Source]', 'null'] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]', 'null'] | +
Dates and other temporal coverage information
+Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Periodicity | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citation Requirements' | +False | +True | +False | +["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +
None
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citations | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +
This section includes information about data access
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +
This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.
+If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +
Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +
Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Structural metadata about tables, columns and values
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +False | +['str', 'null'] | +
The name of a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The data type of values in the column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Type | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
provenance.temporal.accrualPeriodicity --> provenance.temporal.publishingFrequencySystem dataset identifier
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset identifier | +False | +True | +True | +["Uuidv4[{'maxLength': 36, 'minLength': 36, 'pattern': '^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$', 'type': 'string'}]", "Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset metadata version
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +True | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
Summary of metadata describing key pieces of information.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +True | +True | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+Please provide a Grid.ac identifier (see https://www.grid.ac/institutes) for your organisation. If your organisation does not have a Grid.ac identifier please use the “suggest and institute” function here: https://www.grid.ac/institutes#
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Identifier | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Please provide a logo associated with the Gateway Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Logo | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a URL that describes the organisation.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Organisation contact point(s)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +
Please indicate if the organisation is an Alliance Member or a Hub.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Membership | +False | +True | +False | +["MemberOf['HUB','ALLIANCE','OTHER','NCS']", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +
Examples:
+Alternate dataset identifiers or local identifiers
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Alternate dataset identifiers | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +
DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards. Organisations are required to confirm that they have permission to distribute any additional media.
+A free-text description of the dataset. Gateway Feature: Keywords and text may be extracted out of the description and index for search
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question. The following formats will be accepted .jpg, .png or .svg, .pdf, .xslx or .docx. Note: media asset can be hosted by the organisation or uploaded using the onboarding portal.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Examples:
+Please complete only if the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Group | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +
Examples:
+This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Examples:
+Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
Availability of physical samples associated with the dataset. If samples are available, please indicate the types of samples that are available. More than one type may be provided. If sample are not yet available, please provide “AVAILABILITY TO BE CONFIRMED”. If samples are not available, then please provide “NOT AVAILABLE”.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical Sample Availability | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List', 'null'] | +
Examples:
+If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+Coverate by origin (geographical and situations)
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]', 'null'] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Source.Source]', 'null'] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]', 'null'] | +
Dates and other temporal coverage information
+Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Publishing Frequency | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citation Requirements' | +False | +True | +False | +["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +
None
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citations | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +
This section includes information about data access
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +
This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.
+If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +
Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +
Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Structural metadata about tables, columns and values
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +False | +['str', 'null'] | +
The name of a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The data type of values in the column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Type | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
summary.populationSize: new integer field to record the population size of the dataset/cohort in the summary fieldsummary.datasetType: new string field to be used to record the type of dataset (will be changed to enum at some later point )summary.datasetSubType: new string field to be used with summary.datasetType to record the type of datasetcoverage.physicalSampleAvailability --> coverage.biologicalsamples:coverage.gender, list:coverage.psychological, list:coverage.physical, list:coverage.anthropometric, list:coverage.lifestyle, list:coverage.socioeconomic, list:tissuesSampleCollection.dataCategoriestissuesSampleCollection.materialTypetissuesSampleCollection.collectionTypetissuesSampleCollection.tissueSampleMetadata.creationDatetissuesSampleCollection.tissueSampleMetadata.anatomicalSiteOntologyCode:^[C\d]{3}\.\d{4}\/\d{1,4}$System dataset identifier
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset identifier | +False | +True | +True | +["Uuidv4[{'maxLength': 36, 'minLength': 36, 'pattern': '^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$', 'type': 'string'}]", "Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset metadata version
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +True | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
Summary metadata must be completed by Data Custodians onboarding metadata into the Innovation Gateway MVP.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +True | +True | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+Please provide a Grid.ac identifier (see https://www.grid.ac/institutes) for your organisation. If your organisation does not have a Grid.ac identifier please use the “suggest and institute” function here: https://www.grid.ac/institutes#
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Identifier | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Please provide a logo associated with the Gateway Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Logo | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a URL that describes the organisation.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Organisation contact point(s)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +
Please indicate if the organisation is an Alliance Member or a Hub.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Membership | +False | +True | +False | +["MemberOf['HUB','ALLIANCE','OTHER','NCS']", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +
Examples:
+Alternate dataset identifiers or local identifiers
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Alternate dataset identifiers | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +
DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Placeholder for dataset type"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Placeholder for dataset sub-type
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Sub-type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Summary population size of the cohort
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Population size | +False | +True | +True | +['int', 'null'] | +
Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards. Organisations are required to confirm that they have permission to distribute any additional media.
+A free-text description of the dataset. Gateway Feature: Keywords and text may be extracted out of the description and index for search
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question. The following formats will be accepted .jpg, .png or .svg, .pdf, .xslx or .docx. Note: media asset can be hosted by the organisation or uploaded using the onboarding portal.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Examples:
+Please complete only if the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Group | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +
Examples:
+Observational, Spatial and Temporal coverage
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Examples:
+Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Male, Female, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gender | +True | +True | +False | +["GenderType['Male','Female','Other']"] | +
Blood, Saliva, Urine, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Biological Samples | +True | +True | +False | +["BiologicalSampleType['Blood','Other','Urine','Saliva']"] | +
Mental health, Cognitive function
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Psychological | +True | +True | +False | +["PsychologicalType['Cognitive Function','Mental Health']"] | +
Cardiovascular, Respiratory, Musculoskeletal, Hearing and Vision, Reproductive
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical | +True | +True | +False | +["PhysicalType['Respiratory','Vision','Hearing','Musculoskeletal','Cardiovascular','Reproductive']"] | +
Height, Weight, Waist circumference, Hip circumference, Blood pressure
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anthropometric | +True | +True | +False | +["AnthropometricType['Blood Pressure','Hip Circumference','Height','Waist Circumference','Weight']"] | +
Cohort lifestyle habits: Smoking, Physical activity, Dietary habits, Alcohol
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Lifestyle | +True | +True | +False | +["LifestylesType['Smoking','Dietary Habits','Physical Activity','Alcohol']"] | +
Occupation, Family circumstances, Housing, Education, Ethnic group, Martial status, Social support
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Socio-economic | +True | +True | +False | +["SocioEconomicType['Finances','Family Circumstances','Housing','Education','Marital Status','Occupation','Ethnic Group','Social Support']"] | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+Coverate by origin (geographical and situations)
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]', 'null'] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Source.Source]', 'null'] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]', 'null'] | +
Dates and other temporal coverage information
+Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Publishing Frequency | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citation Requirements' | +False | +True | +False | +["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +
None
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citations | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +
This section includes information about data access
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +
This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.
+If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +
Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +
Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +
Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Structural metadata about tables, columns and values
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +False | +['str', 'null'] | +
The name of a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The data type of values in the column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Type | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
Metadata collection for Tissue Samples datasets
+The type of data that is associated with the samples in the study. Can be several values MIABIS-2.0-13
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Categories | +True | +True | +False | +["TissueDataCategoriesEnum['Biological samples','Survey data','Imaging data','Medical records','National registries','Genealogical records','Physiological/Biochemical measurements','Other']"] | +
The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes. Can be several values MIABIS-2.0-14
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Material Type | +True | +True | +False | +["MaterialTypeCategories['Blood','DNA','Faeces','Immortalized Cell Lines','Isolated Pathogen','Other','Plasma','RNA','Saliva','Serum','Tissue (Frozen)','Tissue (FFPE)','Urine']"] | +
Metadata related to the tissue sample
+Date when the tissue sample metadata was created
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Creation Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Ontology code for the anatomical site, this code must match an ICD-0-3 format
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Ontology Code | +False | +True | +False | +["ICD_0_3[{'anyOf': [{'pattern': '^[C\\d]{3}\\.\\d{4}\\/\\d{1,4}$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The type of the sample collection. Can be several values MIABIS-2.0-16
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Type | +False | +True | +False | +["TissueCollectionTypeEnum['Case-control','Cohort','Cross-sectional','Longitudinal','Twin-study','Quality control','Population-based','Disease specific','Birth cohort','Other']", 'null'] | +
enrichmentAndLinkage.syntheticDataWebLink: new field for storing internal/external links to synthetic data resources related to the datasetaccessibility.access.accessServiceCategory: new field for categorising if a dataset access is direct, TRE/SDE, etc.System dataset identifier
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset identifier | +False | +True | +True | +["Uuidv4[{'maxLength': 36, 'minLength': 36, 'pattern': '^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$', 'type': 'string'}]", "Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Dataset metadata version
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+A list of persistent identifiers and version numbers for previous versions of metadata for this dataset
+Version number used for previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision version | +False | +False | +True | +["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"] | +
Examples:
+Some url with a reference to the record of a previous version of this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| revision url | +False | +True | +True | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Datetime stamp of when this metadata version was initially issued
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Metadata Issued Datetime', | +False | +False | +True | +['datetime'] | +
Datetime stamp of when this metadata was last modified
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Last Modified Datetime | +False | +False | +True | +['datetime'] | +
Summary metadata must be completed by Data Custodians onboarding metadata into the Innovation Gateway MVP.
+Title of the dataset limited to 150 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Title | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Examples:
+Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Abstract | +False | +True | +True | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.
+Please provide a Grid.ac identifier (see https://www.grid.ac/institutes) for your organisation. If your organisation does not have a Grid.ac identifier please use the “suggest and institute” function here: https://www.grid.ac/institutes#
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Identifier | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Name of the organisation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Name | +False | +False | +True | +["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] | +
Please provide a logo associated with the Gateway Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Logo | +False | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a URL that describes the organisation.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Organisation contact point(s)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Please indicate if the organisation is an Alliance Member or a Hub.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Membership | +False | +True | +False | +["MemberOf['HUB','ALLIANCE','OTHER','NCS']", 'null'] | +
Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes- An employee's email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose. Gateway Feature: If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Contact Point | +False | +True | +True | +["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Keywords | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Examples:
+Alternate dataset identifiers or local identifiers
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Alternate dataset identifiers | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
DOI associated to this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| DOI Name | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Placeholder for dataset type"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Placeholder for dataset sub-type
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Dataset Sub-type | +False | +True | +True | +["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Summary population size of the cohort
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Population size | +False | +True | +True | +['int', 'null'] | +
Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards. Organisations are required to confirm that they have permission to distribute any additional media.
+A free-text description of the dataset. Gateway Feature: Keywords and text may be extracted out of the description and index for search
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Description | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide any media associated with the Gateway Organisation using a valid URI for the content. This is an opportunity to provide additional context that could be useful for researchers wanting to understand more about the dataset and its relevance to their research question. The following formats will be accepted .jpg, .png or .svg, .pdf, .xslx or .docx. Note: media asset can be hosted by the organisation or uploaded using the onboarding portal.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Associated Media | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Examples:
+Please complete only if the dataset is part of a group or family
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Group | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Examples:
+Observational, Spatial and Temporal coverage
+The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Geographic Coverage | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Examples:
+Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format '[min age] – [max age]' where both the minimum and maximum are whole numbers (integers).
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Age Range | +False | +True | +False | +["AgeRange[{'anyOf': [{'pattern': 'Not Known | +
If known, what is the typical time span that a patient appears in the dataset (follow up period)
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Followup | +False | +True | +False | +["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] | +
Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Pathway | +False | +True | +False | +["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Male, Female, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Gender | +True | +True | +False | +["GenderType['Male','Female','Other']"] | +
Blood, Saliva, Urine, Other
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Biological Samples | +True | +True | +False | +["BiologicalSampleType['Blood','Other','Urine','Saliva']"] | +
Mental health, Cognitive function
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Psychological | +True | +True | +False | +["PsychologicalType['Cognitive Function','Mental Health']"] | +
Cardiovascular, Respiratory, Musculoskeletal, Hearing and Vision, Reproductive
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Physical | +True | +True | +False | +["PhysicalType['Respiratory','Vision','Hearing','Musculoskeletal','Cardiovascular','Reproductive']"] | +
Height, Weight, Waist circumference, Hip circumference, Blood pressure
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anthropometric | +True | +True | +False | +["AnthropometricType['Blood Pressure','Hip Circumference','Height','Waist Circumference','Weight']"] | +
Cohort lifestyle habits: Smoking, Physical activity, Dietary habits, Alcohol
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Lifestyle | +True | +True | +False | +["LifestylesType['Smoking','Dietary Habits','Physical Activity','Alcohol']"] | +
Occupation, Family circumstances, Housing, Education, Ethnic group, Martial status, Social support
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Socio-economic | +True | +True | +False | +["SocioEconomicType['Finances','Family Circumstances','Housing','Education','Marital Status','Occupation','Ethnic Group','Social Support']"] | +
Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.
+Coverate by origin (geographical and situations)
+Please indicate the purpose(s) that the dataset was collected.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Purpose | +True | +True | +False | +["Purpose['STUDY','DISEASE REGISTRY','TRIAL','CARE','AUDIT','ADMINISTRATIVE','FINANCIAL','STATUTORY','OTHER',null]"] | +
Please indicate the source of the data extraction
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Source | +True | +True | +False | +["Source['EPR','ELECTRONIC SURVEY','LIMS','OTHER INFORMATION SYSTEM','PAPER BASED','FREETEXT NLP','MACHINE GENERATED','OTHER']"] | +
Please indicate the setting(s) where data was collected. Multiple settings may be provided
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Situation Setting | +True | +True | +False | +["Setting['CLINIC','PRIMARY CARE','ACCIDENT AND EMERGENCY','OUTPATIENTS','IN-PATIENTS','SERVICES','COMMUNITY','HOME','PRIVATE','PHARMACY','SOCIAL CARE','LOCAL AUTHORITY','NATIONAL GOVERNMENT','OTHER']"] | +
Dates and other temporal coverage information
+Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Release Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
The start of the time period that the dataset provides coverage for. If there are multiple cohorts in the dataset with varying start dates, please provide the earliest date and use the description or the media attribute to provide more information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Start Date | +False | +True | +True | +['date', 'datetime', 'null'] | +
The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please state continuous. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| End Date | +False | +True | +False | +['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null'] | +
Please indicate the typical time-lag between an event and the data for that event appearing in the dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Time Lag | +False | +False | +True | +["TimeLag['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NO TIMELAG','NOT APPLICABLE','OTHER',null]"] | +
Please indicate the frequency of distribution release. If a dataset is distributed regularly please choose a distribution release periodicity from the constrained list and indicate the next release date. When the release date becomes historical, a new release date will be calculated based on the publishing periodicity. If a dataset has been published and will remain static please indicate that it is static and indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Publishing Frequency | +False | +False | +True | +["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+This section includes information about how the data can be used and how it is currently being used
+Please provide an indication of consent permissions for datasets and/or materials, and relates to the purposes for which datasets and/or material might be removed, stored or used. NOTE: we have extended the DUO to include a value for NO LINKAGE
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Limitation | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Please indicate fit here are any additional conditions set for use if any, multiple requirements may be provided. Please ensure that these restrictions are documented in access rights information.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Use Requirements | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Please provide the text that you would like included as part of any citation that credits this dataset. This is typically just the name of the publisher. No employee details should be provided.'
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citation Requirements' | +False | +True | +False | +["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
None
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Investigations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Citations | +False | +True | +False | +["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'List', 'null'] | +
Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.
+Please provide details for the data access rights
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Rights | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Service | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Examples:
+Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Organisation Access Request Cost | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Please provide an indication of the typical processing times based on the types of requests typically received.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access Request Duration | +False | +True | +False | +["DeliveryLeadTime['LESS 1 WEEK','1-2 WEEKS','2-4 WEEKS','1-2 MONTHS','2-6 MONTHS','MORE 6 MONTHS','VARIABLE','NOT APPLICABLE','OTHER',null]", 'null'] | +
Please use country code from ISO 3166-1 country codes and the associated ISO 3166-2 for regions, cities, states etc. for the country/state under whose laws the data subjects' data is collected, processed and stored.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Jurisdiction | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Data Controller means a person/entity who (either alone or jointly or in common with other persons/entities) determines the purposes for which and the way any Data Subject data, specifically personal data or are to be processed.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Controller | +False | +True | +True | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
A Data Processor, in relation to any Data Subject data, specifically personal data, means any person/entity (other than an employee of the data controller) who processes the data on behalf of the data controller.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Processor | +False | +True | +False | +["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Where access to data come from: TRE/SED, direct access, open acccess, varies based on project.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Access/governance requirements | +True | +True | +False | +["AccessService['TRE/SDE','Direct access','Open access','Varies based on project']"] | +
Examples:
+Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.
+List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +True | +True | +True | +["StandardisedDataModels[{'$defs': {'StandardisedDataModelsEnum': {'enum': ['HL7 FHIR', 'HL7 V2', 'HL7 CDA', 'HL7 CCOW', 'LOINC', 'DICOM', 'I2B2', 'IHE', 'OMOP', 'OPENEHR', 'SENTINEL', 'PCORNET', 'CDISC', 'NHS DATA DICTIONARY', 'NHS SCOTLAND DATA DICTIONARY', 'NHS WALES DATA DICTIONARY', 'LOCAL', 'OTHER'], 'title': 'StandardisedDataModelsEnum', 'type': 'string'}}, 'anyOf': [{'$ref': '#/$defs/StandardisedDataModelsEnum'}, {'type': 'null'}], 'default': null}]"] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
List any relevant terminologies / ontologies / controlled vocabularies, such as ICD 10 Codes, NHS Data Dictionary National Codes or SNOMED CT International, that are being used by the dataset. If the controlled vocabularies are local standards, please make that explicit. If you are using a standard that has not been included in the list, please use “other” and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Controlled Vocabulary | +False | +True | +True | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.
+If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Linked Datasets | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Derivations | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Tools | +False | +True | +False | +["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | +
Links to locations of information and or raw downloads of synthetic data associated with this dataset
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Synthetic Data Web Links | +True | +True | +False | +["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] | +
Multiple observations about the dataset may be provided and users are expected to provide at least one observation +(1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. +Example: + <b> Statistical Population 1 + </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 + <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”"
+Please select one of the following statistical populations for you observation
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Statistical Population' | +False | +False | +True | +["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"] | +
Examples:
+Please provide the population size associated with the population type the dataset i.e. 1000 people in a study, or 87 images (MRI) of Knee Usage Note: Used with Statistical Population, which specifies the type of the population in the dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Value | +False | +False | +True | +['int'] | +
If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Disambiguating Description | +False | +True | +False | +["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
Please provide the date that the observation was made. Some datasets may be continuously updated and the number of records will change regularly, so the observation date provides users with the date that the analysis or query was run to generate the particular observation. Multiple observations can be made i.e. an observation of cumulative COVID positive cases by specimen on the 1/1/2021 could be 2M. On the 8/1/2021 a new observation could be 2.1M. Users can add multiple observations.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Observation Date | +False | +False | +True | +['date', 'datetime'] | +
Initially this will be defaulted to "COUNT"
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Measured Property | +False | +False | +True | +['MeasuredProperty[{}]'] | +
Structural metadata about tables, columns and values
+The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +True | +['str', 'null'] | +
The name of a table in a dataset.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Table Name | +False | +True | +False | +['str', 'null'] | +
The name of a table in a dataset.
+The name of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Name | +False | +False | +True | +['Name[{}]'] | +
The data type of values in the column
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Type | +False | +False | +True | +['str'] | +
A description of a column in a table.
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Column Description | +False | +True | +False | +['str', 'null'] | +
A True or False value, indicating if the field is sensitive or not
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Sensitive | +False | +False | +True | +['bool'] | +
Metadata collection for Tissue Samples datasets
+The type of data that is associated with the samples in the study. Can be several values MIABIS-2.0-13
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Data Categories | +True | +True | +False | +["TissueDataCategoriesEnum['Biological samples','Survey data','Imaging data','Medical records','National registries','Genealogical records','Physiological/Biochemical measurements','Other']"] | +
The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes. Can be several values MIABIS-2.0-14
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Material Type | +True | +True | +False | +["MaterialTypeCategories['Blood','DNA','Faeces','Immortalized Cell Lines','Isolated Pathogen','Other','Plasma','RNA','Saliva','Serum','Tissue (Frozen)','Tissue (FFPE)','Urine']"] | +
Metadata related to the tissue sample
+Date when the tissue sample metadata was created
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Creation Date | +False | +True | +False | +['date', 'datetime', 'null'] | +
Ontology code for the anatomical site, this code must match an ICD-0-3 format
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Anatomical Site Ontology Code | +False | +True | +False | +["ICD_0_3[{'anyOf': [{'pattern': '^[C\\d]{3}\\.\\d{4}\\/\\d{1,4}$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] | +
The type of the sample collection. Can be several values MIABIS-2.0-16
+| title | +is_list | +is_optional | +required | +type | +
|---|---|---|---|---|
| Collection Type | +False | +True | +False | +["TissueCollectionTypeEnum['Case-control','Cohort','Cross-sectional','Longitudinal','Twin-study','Quality control','Population-based','Disease specific','Birth cohort','Other']", 'null'] | +