Version 2.2.1

identifier

System dataset identifier

title	guidance	is_list	required	type
Dataset identifier		False	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:

• 226fb3f1-4471-400a-8c39-2b66d46a39b6
• https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6

version

Dataset metadata version

title	guidance	is_list	required	type
Dataset Version		False	True	["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"]

Examples:

• 1.1.0

revisions

A list of persistent identifiers and version numbers for previous versions of metadata for this dataset

version

Version number used for previous version of this dataset

title	guidance	is_list	required	type
revision version		False	True	["Semver[{'pattern': '^([0-9]+)\\.([0-9]+)\\.([0-9]+)$', 'type': 'string'}]"]

Examples:

• 6.0.0

url

Some url with a reference to the record of a previous version of this dataset

title	guidance	is_list	required	type
revision url		False	True	["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null']

Examples:

• https://api.service.nhs.uk/health-research-data-catalogue/datasetrevisions/841f7da2-b018-41f6-b4ae-2e0aadab6561

issued

Datetime stamp of when this metadata version was initially issued

title	guidance	is_list	required	type
Metadata Issued Datetime		False	True	['datetime']

modified

Datetime stamp of when this metadata was last modified

title	guidance	is_list	required	type
Last Modified Datetime		False	True	['datetime']

summary

Summary metadata must be completed by Data Custodians onboarding metadata into the Innovation Gateway MVP.

title

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	guidance	is_list	required	type
Title		False	True	["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"]

Examples:

• North West London COVID-19 Patient Level Situation Report

abstract

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	guidance	is_list	required	type
Dataset Abstract		False	True	["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null']

Examples:

• CPRD Aurum contains primary care data contributed by General Practitioner (GP) practices using EMIS Web® including patient registration information and all care events that GPs have chosen to record as part of their usual medical practice.

publisher

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.

identifier

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	guidance	is_list	required	type
Organisation Identifier		False	False	["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null']

name

Name of the organisation

title	guidance	is_list	required	type
Organisation Name		False	True	["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"]

logo

Please provide a logo associated with the Gateway Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.

title	guidance	is_list	required	type
Organisation Logo		False	False	["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null']

description

Please provide a URL that describes the organisation.

title	guidance	is_list	required	type
Organisation Description		False	False	["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

contactPoint

Organisation contact point(s)

title	guidance	is_list	required	type
Organisation Contact Point		False	True	["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

memberOf

Please indicate if the organisation is an Alliance Member or a Hub.'

title	guidance	is_list	required	type
Organisation Membership		False	False	["MemberOf['HUB','ALLIANCE','OTHER','NCS']", 'null']

contactPoint

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	guidance	is_list	required	type
Contact Point		False	True	["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'null']

Examples:

• SAILDatabank@swansea.ac.uk

keywords

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	guidance	is_list	required	type
Keywords		False	True	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

Examples:

• Preprints,Papers,HDR UK

alternateIdentifiers

Alternate dataset identifiers or local identifiers

title	guidance	is_list	required	type
Alternate dataset identifiers		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

doiName

DOI associated to this dataset

title	guidance	is_list	required	type
DOI Name		False	False	["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null']

Examples:

• 10.1093/ije/dyx196

datasetType

Placeholder for dataset type"

title	guidance	is_list	required	type
Dataset Type		False	True	["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

datasetSubType

Placeholder for dataset sub-type

title	guidance	is_list	required	type
Dataset Sub-type		False	True	["DatasetType[{'anyOf': [{'maxLength': 100, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

populationSize

Summary population size of the cohort

title	guidance	is_list	required	type
Population size		False	True	['int', 'null']

documentation

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.

description

A free-text description of the dataset. Gateway Feature: Keywords and text may be extracted out of the description and index for search

title	guidance	is_list	required	type
Description		False	False	["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

associatedMedia

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	guidance	is_list	required	type
Associated Media		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

Examples:

• PDF Document that describes study protocol

isPartOf

Please complete only if the dataset is part of a group or family

title	guidance	is_list	required	type
Group		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

Examples:

• Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).

coverage

Observational, Spatial and Temporal coverage

spatial

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	guidance	is_list	required	type
Geographic Coverage		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

Examples:

• https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html

typicalAgeRange

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	guidance	is_list	required	type
Age Range		False	False	["AgeRange[{'anyOf': [{'pattern': 'Not Known

Examples:

• 18-90

followup

If known, what is the typical time span that a patient appears in the dataset (follow up period)

title	guidance	is_list	required	type
Followup		False	False	["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null']

pathway

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	guidance	is_list	required	type
Pathway		False	False	["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

gender

Male, Female, Other

title	guidance	is_list	required	type
Gender		True	False	["GenderType['Male','Female','Other']"]

biologicalsamples

Blood, Saliva, Urine, Other

title	guidance	is_list	required	type
Biological Samples		True	False	["BiologicalSampleType['Blood','Other','Urine','Saliva']"]

psychological

Mental health, Cognitive function

title	guidance	is_list	required	type
Psychological		True	False	["PsychologicalType['Cognitive Function','Mental Health']"]

physical

Cardiovascular, Respiratory, Musculoskeletal, Hearing and Vision, Reproductive

title	guidance	is_list	required	type
Physical		True	False	["PhysicalType['Respiratory','Vision','Hearing','Musculoskeletal','Cardiovascular','Reproductive']"]

anthropometric

Height, Weight, Waist circumference, Hip circumference, Blood pressure

title	guidance	is_list	required	type
Anthropometric		True	False	["AnthropometricType['Blood Pressure','Hip Circumference','Height','Waist Circumference','Weight']"]

lifestyle

Cohort lifestyle habits: Smoking, Physical activity, Dietary habits, Alcohol

title	guidance	is_list	required	type
Lifestyle		True	False	["LifestylesType['Smoking','Dietary Habits','Physical Activity','Alcohol']"]

socioeconomic

Occupation, Family circumstances, Housing, Education, Ethnic group, Martial status, Social support

title	guidance	is_list	required	type
Socio-economic		True	False	["SocioEconomicType['Finances','Family Circumstances','Housing','Education','Marital Status','Occupation','Ethnic Group','Social Support']"]

provenance

Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.

origin

Coverate by origin (geographical and situations)

purpose

Please indicate the purpose(s) that the dataset was collected.

title	guidance	is_list	required	type
Purpose		True	False	["Purpose['STUDY','DISEASE REGISTRY','TRIAL','CARE','AUDIT','ADMINISTRATIVE','FINANCIAL','STATUTORY','OTHER',null]"]

source

Please indicate the source of the data extraction

title	guidance	is_list	required	type
Source		True	False	["Source['EPR','ELECTRONIC SURVEY','LIMS','OTHER INFORMATION SYSTEM','PAPER BASED','FREETEXT NLP','MACHINE GENERATED','OTHER']"]

collectionSituation

Please indicate the setting(s) where data was collected. Multiple settings may be provided

title	guidance	is_list	required	type
Collection Situation Setting		True	False	["Setting['CLINIC','PRIMARY CARE','ACCIDENT AND EMERGENCY','OUTPATIENTS','IN-PATIENTS','SERVICES','COMMUNITY','HOME','PRIVATE','PHARMACY','SOCIAL CARE','LOCAL AUTHORITY','NATIONAL GOVERNMENT','OTHER']"]

temporal

Dates and other temporal coverage information

distributionReleaseDate

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	guidance	is_list	required	type
Release Date		False	False	['date', 'datetime', 'null']

startDate

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	guidance	is_list	required	type
Start Date		False	True	['date', 'datetime', 'null']

endDate

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	guidance	is_list	required	type
End Date		False	False	['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null']

timeLag

Please indicate the typical time-lag between an event and the data for that event appearing in the dataset

title	guidance	is_list	required	type
Time Lag		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]"]

publishingFrequency

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	guidance	is_list	required	type
Publishing Frequency		False	True	["Periodicity['STATIC','IRREGULAR','CONTINUOUS','BIENNIAL','ANNUAL','BIANNUAL','QUARTERLY','BIMONTHLY','MONTHLY','BIWEEKLY','WEEKLY','SEMIWEEKLY','DAILY','OTHER',null]"]

accessibility

Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.

usage

This section includes information about how the data can be used and how it is currently being used

dataUseLimitation

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	guidance	is_list	required	type
Data Use Limitation		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

dataUseRequirements

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	guidance	is_list	required	type
Data Use Requirements		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

resourceCreator

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	guidance	is_list	required	type
Citation Requirements'		False	False	["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

investigations

None

title	guidance	is_list	required	type
Investigations		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

isReferencedBy

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	guidance	is_list	required	type
Citations		False	False	["Doi[{'anyOf': [{'pattern': '^10.\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'List', 'null']

access

Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.

accessRights

Please provide details for the data access rights

title	guidance	is_list	required	type
Access Rights		False	True	["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

accessService

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	guidance	is_list	required	type
Access Service		False	False	["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

Examples:

• https://cnfl.extge.co.uk/display/GERE/Research+Environment+User+Guide

accessRequestCost

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	guidance	is_list	required	type
Organisation Access Request Cost		False	False	["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

deliveryLeadTime

Please provide an indication of the typical processing times based on the types of requests typically received.

title	guidance	is_list	required	type
Access Request Duration		False	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']

jurisdiction

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	guidance	is_list	required	type
Jurisdiction		False	True	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

dataController

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	guidance	is_list	required	type
Data Controller		False	True	["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

dataProcessor

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	guidance	is_list	required	type
Data Processor		False	False	["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null']

accessServiceCategory

Where access to data come from: TRE/SED, direct access, open acccess, varies based on project.

title	guidance	is_list	required	type
Access/governance requirements		True	False	["AccessService['TRE/SDE','Direct access','Open access','Varies based on project']"]

Examples:

• TRE/SDE

formatAndStandards

Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.

vocabularyEncodingScheme

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	guidance	is_list	required	type
Controlled Vocabulary		False	True	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

conformsTo

List standardised data models that the dataset has been stored in or transformed to, such as OMOP or FHIR. If the data is only available in a local format, 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.

title	guidance	is_list	required	type
Conforms To		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}]"]

Examples:

• LOCAL,NHS DATA DICTIONARY

language

This should list all the languages in which the dataset metadata and underlying data is made available.

title	guidance	is_list	required	type
Language		False	True	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

format

If multiple formats are available please specify. See application, audio, image, message, model, multipart, text, video, https://www.iana.org/assignments/media-types/media-types.xhtml Note: If your file format is not included in the current list of formats, please indicate other. If you are using the HOP you will be directed to a service desk page where you can request your additional format. If not please go to: https://metadata.atlassian.net/servicedesk/customer/portal/4 to request your format.

title	guidance	is_list	required	type
Format		False	True	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

enrichmentAndLinkage

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.

qualifiedRelation

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	guidance	is_list	required	type
Linked Datasets		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

derivation

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	guidance	is_list	required	type
Derivations		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

tools

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	guidance	is_list	required	type
Tools		False	False	["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null']

syntheticDataWebLink

Links to locations of information and or raw downloads of synthetic data associated with this dataset

title	guidance	is_list	required	type
Synthetic Data Web Links		True	False	["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"]

observations

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”"

observedNode

Please select one of the following statistical populations for you observation

title	guidance	is_list	required	type
Statistical Population		False	True	["StatisticalPopulationConstrained['PERSONS','EVENTS','FINDINGS']"]

Examples:

• PERSONS

measuredValue

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	guidance	is_list	required	type
Measured Value		False	True	['int']

disambiguatingDescription

If SNOMED CT term does not provide sufficient detail, please provide a description that disambiguates the population type.

title	guidance	is_list	required	type
Disambiguating Description		False	False	["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]", 'null']

observationDate

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	guidance	is_list	required	type
Observation Date		False	True	['date', 'datetime']

measuredProperty

Initially this will be defaulted to "COUNT"

title	guidance	is_list	required	type
Measured Property		False	True	["MeasuredProperty[{'maxLength': 100, 'minLength': 1, 'type': 'string'}]"]

structuralMetadata

Structural metadata about tables, columns and values

name

The name of a table in a dataset.

title	guidance	is_list	required	type
Table Name		False	True	['str', 'null']

description

The name of a table in a dataset.

title	guidance	is_list	required	type
Table Name		False	False	['str', 'null']

elements

The name of a table in a dataset.

name

The name of a column in a table.

title	guidance	is_list	required	type
Column Name		False	True	['Name[{}]']

dataType

The data type of values in the column

title	guidance	is_list	required	type
Data Type		False	True	['str']

description

A description of a column in a table.

title	guidance	is_list	required	type
Column Description		False	False	['str', 'null']

sensitive

A True or False value, indicating if the field is sensitive or not

title	guidance	is_list	required	type
Sensitive		False	True	['bool']

tissuesSampleCollection

Metadata collection for Tissue Samples datasets

dataCategories

The type of data that is associated with the samples in the study. Can be several values MIABIS-2.0-13

title	guidance	is_list	required	type
Data Categories		True	False	["TissueDataCategoriesEnum['Biological samples','Survey data','Imaging data','Medical records','National registries','Genealogical records','Physiological/Biochemical measurements','Other']"]

materialType

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	guidance	is_list	required	type
Material Type		True	False	["MaterialTypeCategories['Blood','DNA','Faeces','Immortalized Cell Lines','Isolated Pathogen','Other','Plasma','RNA','Saliva','Serum','Tissue (Frozen)','Tissue (FFPE)','Urine']"]

tissueSampleMetadata

Metadata related to the tissue sample

creationDate

Date when the tissue sample metadata was created

title	guidance	is_list	required	type
Creation Date		False	False	['date', 'datetime', 'null']

AnatomicalSiteOntologyCode

Ontology code for the anatomical site, this code must match an ICD-0-3 format

title	guidance	is_list	required	type
Anatomical Site Ontology Code		False	False	["ICD_0_3[{'anyOf': [{'pattern': '^[C\\d]{3}\\.\\d{4}\\/\\d{1,4}$', 'type': 'string'}, {'type': 'null'}]}]", 'null']

collectionType

The type of the sample collection. Can be several values MIABIS-2.0-16

title	guidance	is_list	required	type
Collection Type		False	False	["TissueCollectionTypeEnum['Case-control','Cohort','Cross-sectional','Longitudinal','Twin-study','Quality control','Population-based','Disease specific','Birth cohort','Other']", 'null']