diff --git a/docs/HDRUK/3.0.0.md b/docs/HDRUK/3.0.0.md
index bc424cf..f6fccef 100644
--- a/docs/HDRUK/3.0.0.md
+++ b/docs/HDRUK/3.0.0.md
@@ -17,9 +17,9 @@ Examples:
Dataset metadata version.
-| title | guidance | is_list | required | type |
-|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------|
-| Dataset Version | Dataset metadata version should follow standard SEMVER naming conventions(https://semver.org). For example: 1.1.0 major.minor.patch.
Major: Significant/breaking changes.
Minor: New features and bug fixes.
Patch: Minor fixes without new features. | False | True | ["Semver[{'pattern': '^([0-9]+)\\\\.([0-9]+)\\\\.([0-9]+)$', 'type': 'string'}]"] |
+| title | guidance | is_list | required | type |
+|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------|
+| Dataset Version | Dataset metadata version should follow standard SEMVER naming conventions(https://semver.org). For example: 1.1.0 major.minor.patch.
Major: Significant/breaking changes.
Minor: New features and bug fixes.
Patch: Minor fixes without new features. | False | True | ["Semver[{'pattern': '^([0-9]+)\\\\.([0-9]+)\\\\.([0-9]+)$', 'type': 'string'}]"] |
Examples:
@@ -96,9 +96,9 @@ 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 | guidance | is_list | required | type |
-|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------|
-| Title | - The **title** 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.
- If the dataset is a **“linked dataset”**, please indicate this using the prefix **“Linked”**.
- Please **avoid acronyms** wherever possible.
- Good titles should summarise the content of the dataset and if relevant, **the region the dataset covers**.
- **Example**: North West London COVID-19 Patient Level Situation Report | False | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] |
+| title | guidance | is_list | required | type |
+|:--------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------|
+| Title | - The **title** 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.
- If the dataset is a **“linked dataset”**, please indicate this using the prefix **“Linked”**.
- Please **avoid acronyms** wherever possible.
- Good titles should summarise the content of the dataset and if relevant, **the region the dataset covers**.
- **Example**: North West London COVID-19 Patient Level Situation Report | False | True | ["OneHundredFiftyCharacters[{'maxLength': 150, 'minLength': 2, 'type': 'string'}]"] |
Examples:
@@ -109,9 +109,9 @@ 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 | guidance | is_list | required | type |
-|:-----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------|
-| Dataset abstract | - The abstract should provide a **clear and brief descriptive** signpost for researchers who are searching for data that may be relevant to their research.\n- The abstract should allow the reader to determine the **scope of the data collection and accurately summarise its content**.\n- Effective abstracts should **avoid long sentences and abbreviations** where possible.\n- Note: Researchers will view Titles and Abstracts when searching for datasets and choosing whether to explore their content further. **Abstracts should be different from the full description** for a dataset.\n- **Example**: 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.', | False | True | ["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]"] |
+| title | guidance | is_list | required | type |
+|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------|
+| Dataset abstract | - The abstract should 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**.
- Effective abstracts should **avoid long sentences and abbreviations** where possible.
- Note: Researchers will view Titles and Abstracts when searching for datasets and choosing whether to explore their content further. **Abstracts should be different from the full description** for a dataset.
- **Example**: 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.', | False | True | ["AbstractText[{'anyOf': [{'maxLength': 500, 'minLength': 5, 'type': 'string'}, {'type': 'null'}]}]"] |
Examples:
@@ -131,10 +131,9 @@ This is the organisation responsible for running or supporting the data access r
Please provide a Research Organization Registry (ROR) identifier (see https://ror.org/) for your organisation.
-| title | guidance | is_list | required | type |
-|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------|
-| identifier | **Example**: https://ror.org/053fq8t95 | False | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
-| | If your organisation does not have a ROR identifier please use the “suggest and institute” function here: https://docs.google.com/forms/d/e/1FAIpQLSdJYaMTCwS7muuTa-B_CnAtCSkKzt19lkirAKG4u7umH9Nosg/viewform | | | |
+| title | guidance | is_list | required | type |
+|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------|
+| identifier | **Example**: https://ror.org/053fq8t95
If your organisation does not have a ROR identifier please use the “suggest and institute” function here: https://docs.google.com/forms/d/e/1FAIpQLSdJYaMTCwS7muuTa-B_CnAtCSkKzt19lkirAKG4u7umH9Nosg/viewform | False | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
@@ -176,9 +175,9 @@ Please provide a URL that describes the organisation.
Organisation contact point(s) which will be used for receiving queries from HDR, and enquiries and data access requests from Researchers.
-| title | guidance | is_list | required | type |
-|:--------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------|
-| contact point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List'] |
+| title | guidance | is_list | required | type |
+|:--------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| contact point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]'] |
@@ -209,9 +208,9 @@ Input the number of people captured within the dataset.
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 | - Please provide **relevant** and **specific keywords** that can **improve the search engine optimization** of your dataset.\n- Please **enter one keyword at a time** and click **Add New Field** to add further keywords.\n- Text from the title is automatically included in the search, there is no need to include this in the keywords.\n- Include words that researcher may include in their searches.\n- **Example**: Health Data, Research, SAIL, Primary care, GP', | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] |
+| title | guidance | is_list | required | type |
+|:---------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Keywords | - Please provide **relevant** and **specific keywords** that can **improve the search engine optimization** of your dataset.
- Please **enter one keyword at a time** and click **Add New Field** to add further keywords.
- Text from the title is automatically included in the search, there is no need to include this in the keywords.
- Include words that researcher may include in their searches.
- **Example**: Health Data, Research, SAIL, Primary care, GP', | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] |
Examples:
@@ -222,9 +221,9 @@ Examples:
DOI associated to this dataset.
-| title | guidance | is_list | required | type |
-|:----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------|
-| DOI for dataset | - Please note: This is **not** the DOI of the publication(s) associated with the dataset.\n- All HDR UK registered **datasets** should either have a **Digital Object Identifier (DOI)** or be working towards obtaining one.\n- If a DOI is available, please provide the DOI.\n- **Example**: 10.1093/ije/dyx196\n- **What happens if I do not have a DOI?**: Contact your academic organisation to find out if there is an existing relationship with a DOI provider. If that is not available, sites such as figshare offer free services to mint a DOI for your dataset. Subsequent versions of the Metadata Exchange will provide a DOI minting service.', | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title | guidance | is_list | required | type |
+|:----------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------|
+| DOI for dataset | - Please note: This is **not** the DOI of the publication(s) associated with the dataset.
- All HDR UK registered **datasets** should either have a **Digital Object Identifier (DOI)** or be working towards obtaining one.
- If a DOI is available, please provide the DOI.
- **Example**: 10.1093/ije/dyx196
- **What happens if I do not have a DOI?**: Contact your academic organisation to find out if there is an existing relationship with a DOI provider. If that is not available, sites such as figshare offer free services to mint a DOI for your dataset. Subsequent versions of the Metadata Exchange will provide a DOI minting service.', | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
Examples:
@@ -235,9 +234,9 @@ Examples:
Please provide a valid email address that can be used to coordinate data access requests.
-| title | guidance | is_list | required | type |
-|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------|
-| Contact point | Organisations are expected to provide a dedicated email address associated with the data access request process. If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting. \n **Note:** An employee's email address can only be provided on a temporary basis and if one is provided, **you must obtain explicit consent for this purpose**. \n- **Example**: '. | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]"] |
+| title | guidance | is_list | required | type |
+|:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------|
+| Contact point | Organisations are expected to provide a dedicated email address associated with the data access request process. If no contact point is provided in this field, this field will be defaulted to the teams support email provided in the teams setting.
**Note:** An employee's email address can only be provided on a temporary basis and if one is provided, **you must obtain explicit consent for this purpose**.
- **Example**: '. | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]"] |
Examples:
@@ -248,9 +247,9 @@ Examples:
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'] |
+| title | guidance | is_list | required | type |
+|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] |
@@ -268,9 +267,9 @@ Documentation can include a rich text description of the dataset or links to med
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 | - An HTML account of the data that **provides context and scope** of the data, **limited to 3000 characters, and/or a resolvable URL** that describes the dataset.\n- Additional information can be recorded and included using media.', | False | False | ["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]"] |
+| title | guidance | is_list | required | type |
+|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------|
+| Description | - An HTML account of the data that **provides context and scope** of the data, **limited to 3000 characters, and/or a resolvable URL** that describes the dataset.
- Additional information can be recorded and included using media.', | False | False | ["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]"] |
@@ -279,9 +278,9 @@ A free-text description of the dataset. Gateway Feature: Keywords and text may b
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 | - Please provide any media associated with the Gateway Organisation **using a valid URL** for the content.\n- 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.\n- Note: media assets can be hosted by the organisation or uploaded using the onboarding portal.\n- **Example**: This could be a **link to a PDF Document** that describes methodology or further detail about the datasets, or a graph or chart that provides further context about the dataset.', | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] |
+| title | guidance | is_list | required | type |
+|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Associated media | - Please provide any media associated with the Gateway Organisation **using a valid URL** 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.
- Note: media assets can be hosted by the organisation or uploaded using the onboarding portal.
- **Example**: This could be a **link to a PDF Document** that describes methodology or further detail about the datasets, or a graph or chart that provides further context about the dataset.', | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] |
Examples:
@@ -312,9 +311,9 @@ This information includes attributes for geographical and temporal coverage, coh
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 | '- The geographical area covered by the dataset.\n- Please provide a valid location.\n- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/ons::index-of-place-names-in-great-britain-november-2021/about).\n- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes).', | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List'] |
+| title | guidance | is_list | required | type |
+|:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Geographic coverage | '- The geographical area covered by the dataset.
- Please provide a valid location.
- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/ons::index-of-place-names-in-great-britain-november-2021/about).
- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes).', | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Url.Url]'] |
Examples:
@@ -325,9 +324,9 @@ Examples:
Please indicate the minimum age in years of participants in the dataset as a whole number (integer).
-| title | guidance | is_list | required | type |
-|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------|
-| Minimum age range | - Please indicate the minimum of the age range in whole years of participants in the dataset.\n- **What if my dataset has participants of all “All Ages” or “Any Ages”?**: In that case, please enter 0. | False | False | ['int', 'null'] |
+| title | guidance | is_list | required | type |
+|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------|
+| Minimum age range | - Please indicate the minimum of the age range in whole years of participants in the dataset.
- **What if my dataset has participants of all “All Ages” or “Any Ages”?**: In that case, please enter 0. | False | False | ['int', 'null'] |
Examples:
@@ -338,9 +337,9 @@ Examples:
Please indicate the maximum age in years of participants in the dataset as a whole number (integer).
-| title | guidance | is_list | required | type |
-|:------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------|
-| Maximum age range | - Please indicate the maximum of the age range in whole years of participants in the dataset.\n- **What if my dataset has participants of all “All Ages” or “Any Ages”?**: In that case, please enter 150. | False | False | ['int', 'null'] |
+| title | guidance | is_list | required | type |
+|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------|
+| Maximum age range | - Please indicate the maximum of the age range in whole years of participants in the dataset.
- **What if my dataset has participants of all “All Ages” or “Any Ages”?**: In that case, please enter 150. | False | False | ['int', 'null'] |
Examples:
@@ -351,9 +350,9 @@ Examples:
The URL where a Researcher can learn more about the completeness of the dataset.
-| title | guidance | is_list | required | type |
-|:--------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------|
-| Dataset coverage/completeness/quality | If your organisation has a publicly available site which contains information on the completeness of a dataset, add that URL here.\n- **Example**: ' | False | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title | guidance | is_list | required | type |
+|:--------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------|
+| Dataset coverage/completeness/quality | If your organisation has a publicly available site which contains information on the completeness of a dataset, add that URL here.
- **Example**: ' | False | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
@@ -362,9 +361,9 @@ The URL where a Researcher can learn more about the completeness of the dataset.
The type of biospecimen saved from a biological entity.
-| title | guidance | is_list | required | type |
-|:-------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Biological sample availability | "Indicate the specimen type, can be several values from the list below: "" '- Availability of physical samples associated with the dataset.\n- If samples are available, please indicate the types of samples that are available.\n- More than one type may be provided.\n- If samples are not yet available, please provide **“Availability to be confirmed”**.\n- If samples are not available, then please provide **“Not available”**.\n\n- **Not available**: Samples associated with the dataset are not available\n- **Bone marrow**: Bone marrow samples associated with the data are available\n- **Cancer cell lines**: Cancer cell line samples associated with the data are available\n- **CDNA/MRNA**: CDNA/MRNA samples associated with the data are available\n- **Core biopsy**: Core biopsy samples associated with the data are available\n- **DNA**: DNA samples associated with the data are available\n- **Entire body organ**: Entire body organ associated with the data are available\n- **Faeces**: Faeces samples associated with the data are available\n- **Immortalized cell lines**: Immortalized cell line samples associated with the data are available\n- **Isolated pathogen**: Isolated pathogen associated with the data are available\n- **MicroRNA**: MicroRNA samples associated with the data are available\n- **Peripheral blood cells**: Peripheral blood cell samples associated with the data are available\n- **Plasma**: Plasma samples associated with the data are available\n- **PM Tissue**: PM Tissue samples associated with the data are available\n- **Primary cells**: Primary cell samples associated with the data are available\n- **RNA**: RNA samples associated with the data are available\n- **Saliva**: Saliva samples associated with the data are available\n- **Serum**: Serum samples associated with the data are available\n- **Swabs**: Swab samples associated with the data are available\n- **Tissue**: Tissue samples associated with the data are available\n - **Urine**: Urine samples associated with the data are available\n- **Whole blood**: Whole blood samples associated with the data are available\n- **Availability to be confirmed**: Availability of samples is currently being confirmed\n- **Other**: Other types of sample available',""" | True | False | ["MaterialTypeCategoriesV2['None/not available','Bone marrow','Cancer cell lines','CDNA/MRNA','Core biopsy','DNA','Entire body organ','Faeces','Immortalized cell lines','Isolated pathogen','MicroRNA','Peripheral blood cells','Plasma','PM Tissue','Primary cells','RNA','Saliva','Serum','Swabs','Tissue','Urine','Whole blood','Availability to be confirmed','Other']"] |
+| title | guidance | is_list | required | type |
+|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Biological sample availability | "Indicate the specimen type, can be several values from the list below: "" '- 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 samples are not yet available, please provide **“Availability to be confirmed”**.
- If samples are not available, then please provide **“Not available”**.
- **Not available**: Samples associated with the dataset are not available
- **Bone marrow**: Bone marrow samples associated with the data are available
- **Cancer cell lines**: Cancer cell line samples associated with the data are available
- **CDNA/MRNA**: CDNA/MRNA samples associated with the data are available
- **Core biopsy**: Core biopsy samples associated with the data are available
- **DNA**: DNA samples associated with the data are available
- **Entire body organ**: Entire body organ associated with the data are available
- **Faeces**: Faeces samples associated with the data are available
- **Immortalized cell lines**: Immortalized cell line samples associated with the data are available
- **Isolated pathogen**: Isolated pathogen associated with the data are available
- **MicroRNA**: MicroRNA samples associated with the data are available
- **Peripheral blood cells**: Peripheral blood cell samples associated with the data are available
- **Plasma**: Plasma samples associated with the data are available
- **PM Tissue**: PM Tissue samples associated with the data are available
- **Primary cells**: Primary cell samples associated with the data are available
- **RNA**: RNA samples associated with the data are available
- **Saliva**: Saliva samples associated with the data are available
- **Serum**: Serum samples associated with the data are available
- **Swabs**: Swab samples associated with the data are available
- **Tissue**: Tissue samples associated with the data are available
- **Urine**: Urine samples associated with the data are available
- **Whole blood**: Whole blood samples associated with the data are available
- **Availability to be confirmed**: Availability of samples is currently being confirmed
- **Other**: Other types of sample available',""" | True | False | ["MaterialTypeCategoriesV2['None/not available','Bone marrow','Cancer cell lines','CDNA/MRNA','Core biopsy','DNA','Entire body organ','Faeces','Immortalized cell lines','Isolated pathogen','MicroRNA','Peripheral blood cells','Plasma','PM Tissue','Primary cells','RNA','Saliva','Serum','Swabs','Tissue','Urine','Whole blood','Availability to be confirmed','Other']"] |
@@ -373,9 +372,9 @@ The type of biospecimen saved from a biological entity.
If known, what is the typical time span that a patient appears in the dataset (follow up period).
-| title | guidance | is_list | required | type |
-|:----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------|
-| Follow-up | If known, please indicate the typical time span that a patient appears in the dataset (follow up period).\n\n- **0 - 6 MONTHS**: Data typically available for a patient over a 0-6 month period\n- **6 - 12 MONTHS**: Data typically available for a patient over a 6-12 month period\n- **1 - 10 YEARS**: Data typically available for a patient over a 1-10 year period\n- **> 10 YEARS**: Data typically available for a patient for over a 10 year period\n- **UNKNOWN**: Timespan is Unknown\n- **OTHER**: Data available for a patient over another time period ', | False | False | ["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] |
+| title | guidance | is_list | required | type |
+|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------|
+| Follow-up | If known, please indicate the typical time span that a patient appears in the dataset (follow up period).
- **0 - 6 MONTHS**: Data typically available for a patient over a 0-6 month period
- **6 - 12 MONTHS**: Data typically available for a patient over a 6-12 month period
- **1 - 10 YEARS**: Data typically available for a patient over a 1-10 year period
- **> 10 YEARS**: Data typically available for a patient for over a 10 year period
- **UNKNOWN**: Timespan is Unknown
- **OTHER**: Data available for a patient over another time period ', | False | False | ["Followup['0 - 6 MONTHS','6 - 12 MONTHS','1 - 10 YEARS','> 10 YEARS','UNKNOWN','CONTINUOUS','OTHER',null]", 'null'] |
@@ -384,9 +383,9 @@ If known, what is the typical time span that a patient appears in the dataset (f
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 |
-|:----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------|
-| Patient pathway description | - Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage.\n- 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.', | False | False | ["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title | guidance | is_list | required | type |
+|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------|
+| Patient pathway description | - 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.', | False | False | ["Description[{'anyOf': [{'maxLength': 10000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
@@ -424,9 +423,9 @@ Coverate by origin (geographical and situations).
Please indicate the purpose(s) that the dataset was collected.
-| title | guidance | is_list | required | type |
-|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------|
-| Purpose of dataset collection | -**Research cohort**: Data collected for a defined group of people.\n- **Study**: Data collected for a specific research study.\n- **Disease registry**: Data collected as part of a disease registry.\n- **Trial**: Data collected for as part of a clinical trial.\n- **Care**: Data collected as part of routine clinical care.\n- **Audit**: Data collected as part of an audit programme\n- **Administrative**: Data collected for administrative and management information purposes\n- **Financial**: Data collected either for payments or for billing\n- **Other**: Data collected for other purpose', | True | False | ["PurposeV2['Research cohort','Study','Disease registry','Trial','Care','Audit','Administrative','Financial','Statuatory','Other',null]"] |
+| title | guidance | is_list | required | type |
+|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------|
+| Purpose of dataset collection | -**Research cohort**: Data collected for a defined group of people.
- **Study**: Data collected for a specific research study.
- **Disease registry**: Data collected as part of a disease registry.
- **Trial**: Data collected for as part of a clinical trial.
- **Care**: Data collected as part of routine clinical care.
- **Audit**: Data collected as part of an audit programme
- **Administrative**: Data collected for administrative and management information purposes
- **Financial**: Data collected either for payments or for billing
- **Other**: Data collected for other purpose', | True | False | ["PurposeV2['Research cohort','Study','Disease registry','Trial','Care','Audit','Administrative','Financial','Statuatory','Other',null]"] |
@@ -457,9 +456,9 @@ The sub-type of the dataset content.
Please indicate the source of the data extraction.
-| title | guidance | is_list | required | type |
-|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------|
-| Source of data extraction | - **EPR**: Data Extracted from Electronic Patient Record\n- **Electronic survey**: Data has been extracted from electronic surveys\n- **LIMS**: Data has been extracted from a laboratory information management system\n- **Paper-based**: Data has been extracted from paper forms\n- **Free text NLP**: Data has been extracted from unstructured freetext using natural language processing\n- **Machine generated**: Data has been machine generated i.e. imaging\n- **Other**: Data has been extracted by other means', | True | False | ["SourceV2['EPR','Electronic survey','LIMS','Paper-based','Free text NLP','Machine generated','Other']"] |
+| title | guidance | is_list | required | type |
+|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------|
+| Source of data extraction | - **EPR**: Data Extracted from Electronic Patient Record
- **Electronic survey**: Data has been extracted from electronic surveys
- **LIMS**: Data has been extracted from a laboratory information management system
- **Paper-based**: Data has been extracted from paper forms
- **Free text NLP**: Data has been extracted from unstructured freetext using natural language processing
- **Machine generated**: Data has been machine generated i.e. imaging
- **Other**: Data has been extracted by other means', | True | False | ["SourceV2['EPR','Electronic survey','LIMS','Paper-based','Free text NLP','Machine generated','Other']"] |
@@ -468,9 +467,9 @@ Please indicate the source of the data extraction.
Please indicate the setting(s) where data was collected. Multiple settings may be provided.
-| title | guidance | is_list | required | type |
-|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Collection source setting | "\n**Cohort, study, trial**: Cohort, study or trial data collection as part of protocol \n**Clinic**: Specific clinic such as antenatal clinic \n**Primary care - Referrals**: General medical practitioner referral to another service \n**Primary care - Clinic**: General medical practitioner practice \n**Primary care - Out of hours**: General medical practitioner care or advice outside of standard hours \n**Secondary care - Accident and emergency**: Accident emergency department \n**Secondary care - Outpatients**: Outpatient care \n**Secondary care - In-patients**: In-patient care \n**Secondary care - Ambulance**: Care provided in association with ambulance service \n**Secondary care - ICU**: Intensive care units, also referred to as critical care units (CCUs) or intensive therapy units (ITUs) \n**Prescribing - Community pharmacy**: Pharmacy based in the community \n**Prescribing - Community pharmacy**: Pharmacy based in a hospital setting \n**Patient report outcome**: Reported by patient \n**Wearables**: Data collection devices worn on the body \n**Local authority**: Local authority or entity associated with a local authority \n**National government**: National government or entity associated with the national government \n**Community**: Community settings \n**Services**: Services such as drug misuse or blood transfusion \n**Home**: Home setting \n**Private**: Private medical clinic \n**Social care - Health care at home**: service provided in the home or residence of a person \n**Social care - Other social data**: service provided in a setting outside of the person's home or residence \n**Census**: collected as part of census \n**Other**: Other setting" | True | False | ["SettingV2['Cohort, study, trial','Clinic','Primary care - Referrals','Primary care - Clinic','Primary care - Out of hours','Secondary care - Accident and Emergency','Secondary care - Outpatients','Secondary care - In-patients','Secondary care - Ambulance','Secondary care - ICU','Prescribing - Community pharmacy','Prescribing - Hospital','Patient report outcome','Wearables','Local authority','National government','Community','Services','Home','Private','Social care - Health care at home','Social care - Other social data','Census','Other',null]"] |
+| title | guidance | is_list | required | type |
+|:--------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Collection source setting | "
**Cohort, study, trial**: Cohort, study or trial data collection as part of protocol
**Clinic**: Specific clinic such as antenatal clinic
**Primary care - Referrals**: General medical practitioner referral to another service
**Primary care - Clinic**: General medical practitioner practice
**Primary care - Out of hours**: General medical practitioner care or advice outside of standard hours
**Secondary care - Accident and emergency**: Accident emergency department
**Secondary care - Outpatients**: Outpatient care
**Secondary care - In-patients**: In-patient care
**Secondary care - Ambulance**: Care provided in association with ambulance service
**Secondary care - ICU**: Intensive care units, also referred to as critical care units (CCUs) or intensive therapy units (ITUs)
**Prescribing - Community pharmacy**: Pharmacy based in the community
**Prescribing - Community pharmacy**: Pharmacy based in a hospital setting
**Patient report outcome**: Reported by patient
**Wearables**: Data collection devices worn on the body
**Local authority**: Local authority or entity associated with a local authority
**National government**: National government or entity associated with the national government
**Community**: Community settings
**Services**: Services such as drug misuse or blood transfusion
**Home**: Home setting
**Private**: Private medical clinic
**Social care - Health care at home**: service provided in the home or residence of a person
**Social care - Other social data**: service provided in a setting outside of the person's home or residence
**Census**: collected as part of census
**Other**: Other setting" | True | False | ["SettingV2['Cohort, study, trial','Clinic','Primary care - Referrals','Primary care - Clinic','Primary care - Out of hours','Secondary care - Accident and Emergency','Secondary care - Outpatients','Secondary care - In-patients','Secondary care - Ambulance','Secondary care - ICU','Prescribing - Community pharmacy','Prescribing - Hospital','Patient report outcome','Wearables','Local authority','National government','Community','Services','Home','Private','Social care - Health care at home','Social care - Other social data','Census','Other',null]"] |
@@ -499,9 +498,9 @@ 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 | guidance | is_list | required | type |
-|:---------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Publishing frequency | '- Please indicate the frequency of publishing.\n- If a dataset is published regularly please choose a publishing periodicity from the constrained list and indicate the next release date.\n- When the release date becomes historical, a new release date will be calculated based on the publishing periodicity.\n- If a dataset has been published and will remain static please indicate that it is static and indicate when it was released.\n- If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null.\n- 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.\n- Notes: see \n- **Static**: Dataset published once.\n- **Irregular**: Dataset published at uneven intervals.\n- **Continuous**: Dataset published without interruption.\n- **Biennial**: Dataset published every two years.\n- **Annual**: Dataset published occurs once a year.\n- **Biannual**: Dataset published twice a year.\n- **Quarterly**: Dataset published every three months.\n- **Bimonthly**: Dataset published every two months.\n- **Monthly**: Dataset published once a month.\n- **Biweekly**: Dataset published every two weeks.\n- **Weekly**: Dataset published once a week.\n- **Twice weekly**: Dataset published twice a week.\n- **Daily**: Dataset published once a day.\n- **Other**: Dataset published using other interval.', | False | True | ["PeriodicityV2['Static','Irregular','Continuous','Biennial','Annual','Biannual','Quarterly','Bimonthly','Monthly','Biweekly','Weekly','Twice a week','Daily','Other',null]"] |
+| title | guidance | is_list | required | type |
+|:---------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Publishing frequency | '- Please indicate the frequency of publishing.
- If a dataset is published regularly please choose a publishing 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 indicate 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
- **Static**: Dataset published once.
- **Irregular**: Dataset published at uneven intervals.
- **Continuous**: Dataset published without interruption.
- **Biennial**: Dataset published every two years.
- **Annual**: Dataset published occurs once a year.
- **Biannual**: Dataset published twice a year.
- **Quarterly**: Dataset published every three months.
- **Bimonthly**: Dataset published every two months.
- **Monthly**: Dataset published once a month.
- **Biweekly**: Dataset published every two weeks.
- **Weekly**: Dataset published once a week.
- **Twice weekly**: Dataset published twice a week.
- **Daily**: Dataset published once a day.
- **Other**: Dataset published using other interval.', | False | True | ["PeriodicityV2['Static','Irregular','Continuous','Biennial','Annual','Biannual','Quarterly','Bimonthly','Monthly','Biweekly','Weekly','Twice a week','Daily','Other',null]"] |
@@ -510,9 +509,9 @@ Please indicate the frequency of distribution release. If a dataset is distribut
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 |
-|:--------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------|
-| Distribution release date | '- Please indicate the frequency the dataset is published.\n- If a dataset is published regularly please choose a publishing periodicity from the constrained list and indicate the next release date.\n- When the release date becomes historical, a new release date will be calculated based on the publishing periodicity.\n- If a dataset has been published and will remain static please indicate that it is static and indicate when it was released.\n- If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null.\n- 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.\n- Notes: see ', | False | False | ['date', 'datetime', 'null'] |
+| title | guidance | is_list | required | type |
+|:--------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------|
+| Distribution release date | '- Please indicate the frequency the dataset is published.
- If a dataset is published regularly please choose a publishing 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 indicate 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 ', | False | False | ['date', 'datetime', 'null'] |
@@ -521,9 +520,9 @@ Date of the latest release of the dataset. If this is a regular release i.e. qua
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 | - The start of the time period that the dataset provides coverage for.\n- 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.', | False | True | ['date', 'datetime'] |
+| title | guidance | is_list | required | type |
+|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------|
+| Start date | - 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.', | False | True | ['date', 'datetime'] |
@@ -532,9 +531,9 @@ The start of the time period that the dataset provides coverage for. If there ar
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 | - The end of the time period that the dataset provides coverage for.\n- If the dataset is **“Continuous”** and has no known end date, **please leave blank**.\n- If there are **multiple cohorts** in the dataset with varying end dates, please provide the **latest date**.', | False | False | ['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null'] |
+| title | guidance | is_list | required | type |
+|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------|
+| End date | - The end of the time period that the dataset provides coverage for.
- If the dataset is **“Continuous”** and has no known end date, **please leave blank**.
- If there are **multiple cohorts** in the dataset with varying end dates, please provide the **latest date**.', | False | False | ['date', 'datetime', "EndDateEnum['CONTINUOUS',null]", 'null'] |
@@ -543,9 +542,9 @@ The end of the time period that the dataset provides coverage for. If the datase
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 | Please indicate the typical time-lag between an event and the data for that event appearing in the dataset.\n\n- **Less than 1 week**: Typical time lag of less than a week\n- **1-2 weeks**: Typical time lag of one to two weeks\n- **2-4 weeks**: Typical time lag of two to four weeks\n- **1-2 months**: Typical time lag of one to two months\n- **2-6 months**: Typical time lag of two to six months\n- **6 months plus**: Typical time lag of more than six months\n- **Variable**: Variable time lag\n- **Not applicable**: Not Applicable i.e. static dataset\n- **Other**: Other time lag', | False | True | ["TimeLagV2['Less than 1 week','1-2 weeks','2-4 weeks','1-2 months','2-6 months','6 months plus','Variable','Not applicable','Other']"] |
+| title | guidance | is_list | required | type |
+|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------|
+| Time lag | Please indicate the typical time-lag between an event and the data for that event appearing in the dataset.
- **Less than 1 week**: Typical time lag of less than a week
- **1-2 weeks**: Typical time lag of one to two weeks
- **2-4 weeks**: Typical time lag of two to four weeks
- **1-2 months**: Typical time lag of one to two months
- **2-6 months**: Typical time lag of two to six months
- **6 months plus**: Typical time lag of more than six months
- **Variable**: Variable time lag
- **Not applicable**: Not Applicable i.e. static dataset
- **Other**: Other time lag', | False | True | ["TimeLagV2['Less than 1 week','1-2 weeks','2-4 weeks','1-2 months','2-6 months','6 months plus','Variable','Not applicable','Other']"] |
@@ -572,9 +571,9 @@ This section includes information about how the data can be used and how it is c
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 | 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.\n\n- **General research use**: This data use limitation indicates that use is allowed for general research use for any research purpose\n- **Genetic studies only**: This data use limitation indicates that use is limited to genetic studies only (i.e., no phenotype-only research)\n- **No general methods research**: This data use limitation indicates that use includes methods development research(e.g., development of software or algorithms) only within the bounds of other use limitations.\n- **No restriction**: This data use limitation indicates there is no restriction on use.\n- **Research-specific restrictions**: This data use limitation indicates that use is limited to studies of a certain research type.\n- **Research use only**: This data use limitation indicates that use is limited to research purposes (e.g., does not include its use in clinical care).\n- **No linkage**: This data use limitation indicates there is a restriction on linking to any other datasets', | True | False | ["DataUseLimitationV2['General research use','Genetic studies only','No general methods research','No restriction','Research-specific restrictions','Research use only','No linkage']"] |
+| title | guidance | is_list | required | type |
+|:--------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Data use limitation | 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.
- **General research use**: This data use limitation indicates that use is allowed for general research use for any research purpose
- **Genetic studies only**: This data use limitation indicates that use is limited to genetic studies only (i.e., no phenotype-only research)
- **No general methods research**: This data use limitation indicates that use includes methods development research(e.g., development of software or algorithms) only within the bounds of other use limitations.
- **No restriction**: This data use limitation indicates there is no restriction on use.
- **Research-specific restrictions**: This data use limitation indicates that use is limited to studies of a certain research type.
- **Research use only**: This data use limitation indicates that use is limited to research purposes (e.g., does not include its use in clinical care).
- **No linkage**: This data use limitation indicates there is a restriction on linking to any other datasets', | True | False | ["DataUseLimitationV2['General research use','Genetic studies only','No general methods research','No restriction','Research-specific restrictions','Research use only','No linkage']"] |
@@ -583,9 +582,9 @@ Please provide an indication of consent permissions for datasets and/or material
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 | - Please indicate if there are any additional conditions set for use if any, multiple requirements may be provided.\n- Please ensure that these restrictions are documented in access rights information.\n\n- **Collaboration required**: This requirement indicates that the requestor must agree to collaboration with the primary study investigator(s).\n- **Ethics approval required**: This requirement indicates that the requestor must provide documentation of local IRB/ERB approval.\n- **Geographical restrictions**: This requirement indicates that use is limited to within a specific geographic region.\n- **Institution-specific restrictions**: This requirement indicates that use is limited to use within an approved institution.\n- **Not for profit use**: This requirement indicates that use of the data is limited to not-for-profit organizations and not-for-profit use, non-commercial use.\n- **Project-specific restrictions**: This requirement indicates that use is limited to use within an approved project.\n- **Publication moratorium**: This requirement indicates that requestor agrees not to publish results of studies until a specific date.\n- **Publication required**: This requirement indicates that requestor agrees to make results of studies using the data available to the larger scientific community.\n- **Return to database or resource**: This requirement indicates that the requestor must return derived/enriched data to the database/resource.\n- **Time limit on use**: This requirement indicates that use is approved for a specific number of months.\n- **User-specific restriction**: This requirement indicates that use is limited to use by approved users.', | True | False | ["DataUseRequirementsV2['Collaboration required','Ethics approval required','Geographical restrictions','Institution-specific restrictions','Not for profit use','Project-specific restrictions','Publication moratorium','Publication required','Return to database or resource','Time limit on use','User-specific restriction']"] |
+| title | guidance | is_list | required | type |
+|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Data use requirements | - Please indicate if there 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.
- **Collaboration required**: This requirement indicates that the requestor must agree to collaboration with the primary study investigator(s).
- **Ethics approval required**: This requirement indicates that the requestor must provide documentation of local IRB/ERB approval.
- **Geographical restrictions**: This requirement indicates that use is limited to within a specific geographic region.
- **Institution-specific restrictions**: This requirement indicates that use is limited to use within an approved institution.
- **Not for profit use**: This requirement indicates that use of the data is limited to not-for-profit organizations and not-for-profit use, non-commercial use.
- **Project-specific restrictions**: This requirement indicates that use is limited to use within an approved project.
- **Publication moratorium**: This requirement indicates that requestor agrees not to publish results of studies until a specific date.
- **Publication required**: This requirement indicates that requestor agrees to make results of studies using the data available to the larger scientific community.
- **Return to database or resource**: This requirement indicates that the requestor must return derived/enriched data to the database/resource.
- **Time limit on use**: This requirement indicates that use is approved for a specific number of months.
- **User-specific restriction**: This requirement indicates that use is limited to use by approved users.', | True | False | ["DataUseRequirementsV2['Collaboration required','Ethics approval required','Geographical restrictions','Institution-specific restrictions','Not for profit use','Project-specific restrictions','Publication moratorium','Publication required','Return to database or resource','Time limit on use','User-specific restriction']"] |
@@ -594,9 +593,9 @@ Please indicate fit here are any additional conditions set for use if any, multi
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 | - Please provide the text that you would like included as part of any citation that credits this dataset.\n- This is typically just the name of the publisher. No employee details should be provided.\n- To add multiple entries, please click on **'+' symbol** to enter each separate website.\n- **Example**: National Services Scotland', | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] |
+| title | guidance | is_list | required | type |
+|:----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Citation requirements | - 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.
- To add multiple entries, please click on **'+' symbol** to enter each separate website.
- **Example**: National Services Scotland', | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] |
@@ -614,9 +613,9 @@ Accessibility information allows researchers to understand access, usage, limita
Please provide details for the data access rights.
-| title | guidance | is_list | required | type |
-|:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------|
-| Access rights | - The URL of a webpage where the data access request process and/or guidance is provided. If there is more than one access process i.e. industry vs academic please provide both.\n- If such a resource or the underlying process doesn’t exist, please provide “In Progress”, until both the process and the documentation are ready.', | False | True | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]"] |
+| title | guidance | is_list | required | type |
+|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------|
+| Access rights | - The URL of a webpage where the data access request process and/or guidance is provided. If there is more than one access process i.e. industry vs academic please provide both.
- If such a resource or the underlying process doesn’t exist, please provide “In Progress”, until both the process and the documentation are ready.', | False | True | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]"] |
@@ -649,9 +648,9 @@ Indication of the application type to enable research access.
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 description | Please provide a brief description of the data access services that are available including:\n- environment that is currently available to researchers\n- additional consultancy and services\n- any indication of costs associated\n\nIf no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers.\n\nNote: 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.', | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title | guidance | is_list | required | type |
+|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------|
+| Access service description | 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.', | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
Examples:
@@ -673,9 +672,9 @@ Please provide link(s) to a webpage or description detailing the service or cost
Please provide an indication of the typical processing times based on the types of requests typically received.
-| title | guidance | is_list | required | type |
-|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Time to dataset access | - **Less than 1 week**: Access request process typically processed in less than a week\n- **1-2 weeks**: Access request process typically processed in one to two weeks\n- **2-4 weeks**: Access request process typically processed in two to four weeks\n- **1-2 months**: Access request process typically processed in one to two months\n- **2-6 months**: Access request process typically processed in two to six months\n- **More than 6 months**: Access request process typically processed in more than six months\n- **Variable**: Access request lead time is variable\n- **Not applicable**: Access request process duration is not applicable\n- **Other**: If the typical timeframe does not fit into the broad ranges i.e. lightweight application vs linked data application, please choose “Other” and indicate the typical timeframe within the description for the dataset.', | False | False | ["DeliveryLeadTimeV2['Less than 1 week','1-2 weeks','2-4 weeks','1-2 months','2-6 months','More than 6 months','Variable','Not applicable','Other']", 'null'] |
+| title | guidance | is_list | required | type |
+|:-----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Time to dataset access | - **Less than 1 week**: Access request process typically processed in less than a week
- **1-2 weeks**: Access request process typically processed in one to two weeks
- **2-4 weeks**: Access request process typically processed in two to four weeks
- **1-2 months**: Access request process typically processed in one to two months
- **2-6 months**: Access request process typically processed in two to six months
- **More than 6 months**: Access request process typically processed in more than six months
- **Variable**: Access request lead time is variable
- **Not applicable**: Access request process duration is not applicable
- **Other**: If the typical timeframe does not fit into the broad ranges i.e. lightweight application vs linked data application, please choose “Other” and indicate the typical timeframe within the description for the dataset.', | False | False | ["DeliveryLeadTimeV2['Less than 1 week','1-2 weeks','2-4 weeks','1-2 months','2-6 months','More than 6 months','Variable','Not applicable','Other']", 'null'] |
@@ -684,9 +683,9 @@ Please provide an indication of the typical processing times based on the types
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 | "- **GB-ENG**: England\n- **GB-NIR**: Northern Ireland\n- **GB-SCT**: Scotland\n- **GB-WLS**: Wales [Cymru GB-CYM]\n- **GB-EAW**: England and Wales\n- **GB-GBN**: Great Britain\n- **AF**: Afghanistan\n- **AL**: Albania\n- **DZ**: Algeria\n- **AD**: Andorra\n- **AO**: Angola\n- **AG**: Antigua and Barbuda\n- **AR**: Argentina\n- **AM**: Armenia\n- **AU**: Australia\n- **AT**: Austria\n- **AZ**: Azerbaijan\n- **BS**: Bahamas\n- **BH**: Bahrain\n- **BD**: Bangladesh\n- **BB**: Barbados\n- **BY**: Belarus\n- **BE**: Belgium\n- **BZ**: Belize\n- **BJ**: Benin\n- **BT**: Bhutan\n- **BO**: Bolivia (Plurinational State of)\n- **BA**: Bosnia and Herzegovina\n- **BW**: Botswana\n- **BR**: Brazil\n- **BN**: Brunei Darussalam\n- **BG**: Bulgaria\n- **BF**: Burkina Faso\n- **BI**: Burundi\n- **CV**: Cabo Verde\n- **KH**: Cambodia\n- **CM**: Cameroon\n- **CA**: Canada\n- **CF**: Central African Republic\n- **TD**: Chad\n- **CL**: Chile\n- **CN**: China\n- **CO**: Colombia\n- **KM**: Comoros\n- **CG**: Congo\n- **CD**: Congo, Democratic Republic of the\n- **CR**: Costa Rica\n- **CI**: Côte d'Ivoire\n- **HR**: Croatia\n- **CU**: Cuba\n- **CY**: Cyprus\n- **CZ**: Czechia\n- **DK**: Denmark\n- **DJ**: Djibouti\n- **DM**: Dominica\n- **DO**: Dominican Republic\n- **EC**: Ecuador\n- **EG**: Egypt\n- **SV**: El Salvador\n- **GQ**: Equatorial Guinea\n- **ER**: Eritrea\n- **EE**: Estonia\n- **SZ**: Eswatini\n- **ET**: Ethiopia\n- **FJ**: Fiji\n- **FI**: Finland\n- **FR**: France\n- **GA**: Gabon\n- **GM**: Gambia\n- **GE**: Georgia\n- **DE**: Germany\n- **GH**: Ghana\n- **GR**: Greece\n- **GD**: Grenada\n- **GT**: Guatemala\n- **GN**: Guinea\n- **GW**: Guinea-Bissau\n- **GY**: Guyana\n- **HT**: Haiti\n- **VA**: Holy See\n- **HN**: Honduras\n- **HU**: Hungary\n- **IS**: Iceland\n- **IN:** India\n- **ID**: Indonesia\n- **IR**: Iran (Islamic Republic of)\n- **IQ**: Iraq\n- **IE**: Ireland\n- **IL**: Israel\n- **IT**: Italy\n- **JM**: Jamaica\n- **JP**: Japan\n- **JO**: Jordan\n- **KZ**: Kazakhstan\n- **KE**: Kenya\n- **KI**: Kiribati\n- **KP**: Korea (Democratic People's Republic of)\n- **KR**: Korea, Republic of\n- **KW**: Kuwait\n- **KG**: Kyrgyzstan\n- **LA**: Lao People's Democratic Republic\n- **LV**: Latvia\n- **LB**: Lebanon\n- **LS**: Lesotho\n- **LR**: Liberia\n- **LY**: Libya\n- **LI**: Liechtenstein\n- **LT**: Lithuania\n- **LU**: Luxembourg\n- **MG**: Madagascar\n- **MW**: Malawi\n- **MY**: Malaysia\n- **MV**: Maldives\n- **ML**: Mali\n- **MT**: Malta\n- **MH**: Marshall Islands\n- **MR**: Mauritania\n- **MU**: Mauritius\n- **MX**: Mexico\n- **FM**: Micronesia (Federated States of)\n- **MD**: Moldova, Republic of\n- **MC**: Monaco\n- **MN**: Mongolia\n- **ME**: Montenegro\n- **MA**: Morocco\n- **MZ**: Mozambique\n- **MM**: Myanmar\n- **NA**: Namibia\n- **NR**: Nauru\n- **NP**: Nepal\n- **NL**: Netherlands\n- **NZ**: New Zealand\n- **NI**: Nicaragua\n- **NE**: Niger\n- **NG**: Nigeria\n- **MK**: North Macedonia\n- **NO**: Norway\n- **OM**: Oman\n- **PK**: Pakistan\n- **PW**: Palau\n- **PA**: Panama\n- **PG**: Papua New Guinea\n- **PY**: Paraguay\n- **PE**: Peru\n- **PH**: Philippines\n- **PL**: Poland\n- **PT**: Portugal\n- **QA**: Qatar\n- **RO**: Romania\n- **RU**: Russian Federation\n- **RW**: Rwanda\n- **KN**: Saint Kitts and Nevis\n- **LC**: Saint Lucia\n- **VC**: Saint Vincent and the Grenadines\n- **WS**: Samoa\n- **SM**: San Marino\n- **ST**: Sao Tome and Principe\n- **SA**: Saudi Arabia\n- **SN**: Senegal\n- **RS**: Serbia\n- **SC**: Seychelles\n- **SL**: Sierra Leone\n- **SG**: Singapore\n- **SK**: Slovakia\n- **SI**: Slovenia\n- **SB**: Solomon Islands\n- **SO**: Somalia\n- **ZA**: South Africa\n- **SS**: South Sudan\n- **ES**: Spain\n- **LK**: Sri Lanka\n- **SD**: Sudan\n- **SR**: Suriname\n- **SE**: Sweden\n- **CH**: Switzerland\n- **SY**: Syrian Arab Republic\n- **TJ**: Tajikistan\n- **TZ**: Tanzania, United Republic of\n- **TH**: Thailand\n- **TL**: Timor-Leste\n- **TG**: Togo\n- **TO**: Tonga\n- **TT**: Trinidad and Tobago\n- **TN**: Tunisia\n- **TR**: Turkey\n- **TM**: Turkmenistan\n- **TV**: Tuvalu\n- **UG**: Uganda\n- **UA**: Ukraine\n- **AE**: United Arab Emirates\n- **GB**: United Kingdom of Great Britain and Northern Ireland\n- **US**: United States of America\n- **UY**: Uruguay\n- **UZ**: Uzbekistan\n- **VU**: Vanuatu\n- **VE**: Venezuela (Bolivarian Republic of)\n- **VN**: Viet Nam\n- **YE**: Yemen\n- **ZM**: Zambia\n- **ZW**: Zimbabwe", | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] |
+| title | guidance | is_list | required | type |
+|:-------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Jurisdiction | "- **GB-ENG**: England
- **GB-NIR**: Northern Ireland
- **GB-SCT**: Scotland
- **GB-WLS**: Wales [Cymru GB-CYM]
- **GB-EAW**: England and Wales
- **GB-GBN**: Great Britain
- **AF**: Afghanistan
- **AL**: Albania
- **DZ**: Algeria
- **AD**: Andorra
- **AO**: Angola
- **AG**: Antigua and Barbuda
- **AR**: Argentina
- **AM**: Armenia
- **AU**: Australia
- **AT**: Austria
- **AZ**: Azerbaijan
- **BS**: Bahamas
- **BH**: Bahrain
- **BD**: Bangladesh
- **BB**: Barbados
- **BY**: Belarus
- **BE**: Belgium
- **BZ**: Belize
- **BJ**: Benin
- **BT**: Bhutan
- **BO**: Bolivia (Plurinational State of)
- **BA**: Bosnia and Herzegovina
- **BW**: Botswana
- **BR**: Brazil
- **BN**: Brunei Darussalam
- **BG**: Bulgaria
- **BF**: Burkina Faso
- **BI**: Burundi
- **CV**: Cabo Verde
- **KH**: Cambodia
- **CM**: Cameroon
- **CA**: Canada
- **CF**: Central African Republic
- **TD**: Chad
- **CL**: Chile
- **CN**: China
- **CO**: Colombia
- **KM**: Comoros
- **CG**: Congo
- **CD**: Congo, Democratic Republic of the
- **CR**: Costa Rica
- **CI**: Côte d'Ivoire
- **HR**: Croatia
- **CU**: Cuba
- **CY**: Cyprus
- **CZ**: Czechia
- **DK**: Denmark
- **DJ**: Djibouti
- **DM**: Dominica
- **DO**: Dominican Republic
- **EC**: Ecuador
- **EG**: Egypt
- **SV**: El Salvador
- **GQ**: Equatorial Guinea
- **ER**: Eritrea
- **EE**: Estonia
- **SZ**: Eswatini
- **ET**: Ethiopia
- **FJ**: Fiji
- **FI**: Finland
- **FR**: France
- **GA**: Gabon
- **GM**: Gambia
- **GE**: Georgia
- **DE**: Germany
- **GH**: Ghana
- **GR**: Greece
- **GD**: Grenada
- **GT**: Guatemala
- **GN**: Guinea
- **GW**: Guinea-Bissau
- **GY**: Guyana
- **HT**: Haiti
- **VA**: Holy See
- **HN**: Honduras
- **HU**: Hungary
- **IS**: Iceland
- **IN:** India
- **ID**: Indonesia
- **IR**: Iran (Islamic Republic of)
- **IQ**: Iraq
- **IE**: Ireland
- **IL**: Israel
- **IT**: Italy
- **JM**: Jamaica
- **JP**: Japan
- **JO**: Jordan
- **KZ**: Kazakhstan
- **KE**: Kenya
- **KI**: Kiribati
- **KP**: Korea (Democratic People's Republic of)
- **KR**: Korea, Republic of
- **KW**: Kuwait
- **KG**: Kyrgyzstan
- **LA**: Lao People's Democratic Republic
- **LV**: Latvia
- **LB**: Lebanon
- **LS**: Lesotho
- **LR**: Liberia
- **LY**: Libya
- **LI**: Liechtenstein
- **LT**: Lithuania
- **LU**: Luxembourg
- **MG**: Madagascar
- **MW**: Malawi
- **MY**: Malaysia
- **MV**: Maldives
- **ML**: Mali
- **MT**: Malta
- **MH**: Marshall Islands
- **MR**: Mauritania
- **MU**: Mauritius
- **MX**: Mexico
- **FM**: Micronesia (Federated States of)
- **MD**: Moldova, Republic of
- **MC**: Monaco
- **MN**: Mongolia
- **ME**: Montenegro
- **MA**: Morocco
- **MZ**: Mozambique
- **MM**: Myanmar
- **NA**: Namibia
- **NR**: Nauru
- **NP**: Nepal
- **NL**: Netherlands
- **NZ**: New Zealand
- **NI**: Nicaragua
- **NE**: Niger
- **NG**: Nigeria
- **MK**: North Macedonia
- **NO**: Norway
- **OM**: Oman
- **PK**: Pakistan
- **PW**: Palau
- **PA**: Panama
- **PG**: Papua New Guinea
- **PY**: Paraguay
- **PE**: Peru
- **PH**: Philippines
- **PL**: Poland
- **PT**: Portugal
- **QA**: Qatar
- **RO**: Romania
- **RU**: Russian Federation
- **RW**: Rwanda
- **KN**: Saint Kitts and Nevis
- **LC**: Saint Lucia
- **VC**: Saint Vincent and the Grenadines
- **WS**: Samoa
- **SM**: San Marino
- **ST**: Sao Tome and Principe
- **SA**: Saudi Arabia
- **SN**: Senegal
- **RS**: Serbia
- **SC**: Seychelles
- **SL**: Sierra Leone
- **SG**: Singapore
- **SK**: Slovakia
- **SI**: Slovenia
- **SB**: Solomon Islands
- **SO**: Somalia
- **ZA**: South Africa
- **SS**: South Sudan
- **ES**: Spain
- **LK**: Sri Lanka
- **SD**: Sudan
- **SR**: Suriname
- **SE**: Sweden
- **CH**: Switzerland
- **SY**: Syrian Arab Republic
- **TJ**: Tajikistan
- **TZ**: Tanzania, United Republic of
- **TH**: Thailand
- **TL**: Timor-Leste
- **TG**: Togo
- **TO**: Tonga
- **TT**: Trinidad and Tobago
- **TN**: Tunisia
- **TR**: Turkey
- **TM**: Turkmenistan
- **TV**: Tuvalu
- **UG**: Uganda
- **UA**: Ukraine
- **AE**: United Arab Emirates
- **GB**: United Kingdom of Great Britain and Northern Ireland
- **US**: United States of America
- **UY**: Uruguay
- **UZ**: Uzbekistan
- **VU**: Vanuatu
- **VE**: Venezuela (Bolivarian Republic of)
- **VN**: Viet Nam
- **YE**: Yemen
- **ZM**: Zambia
- **ZW**: Zimbabwe", | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] |
@@ -695,9 +694,9 @@ Please use country code from ISO 3166-1 country codes and the associated ISO 316
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 | - 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.\n- Notes: For most organisations this will be the same as the publisher of the dataset. If this is not the case, please indicate that there is a different controller.\n- If there is a different controller please complete the Data Processor attribute to indicate that the publisher is a Processor rather than the data controller.\n- In some cases, there may be multiple data controllers i.e. GP data. If this is the case please indicate the fact in a free-text field and describe the data sharing arrangement or a link to it, so that this can be understood by research users.\n- **Example**: NHS DIGITAL', | False | True | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title | guidance | is_list | required | type |
+|:----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------|
+| Data Controller | - 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.
- Notes: For most organisations this will be the same as the publisher of the dataset. If this is not the case, please indicate that there is a different controller.
- If there is a different controller please complete the Data Processor attribute to indicate that the publisher is a Processor rather than the data controller.
- In some cases, there may be multiple data controllers i.e. GP data. If this is the case please indicate the fact in a free-text field and describe the data sharing arrangement or a link to it, so that this can be understood by research users.
- **Example**: NHS DIGITAL', | False | True | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
@@ -706,9 +705,9 @@ Data Controller means a person/entity who (either alone or jointly or in common
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 | - 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.\n- Notes: Required to complete if the Publisher is the Data Processor rather than the data controller.\n- If the Publisher is also the Data Controller please provide “Not Applicable”.\n- **Examples**:\n- Not Applicable\n- SAIL', | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
+| title | guidance | is_list | required | type |
+|:---------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------|
+| Data Processor | - 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.
- Notes: Required to complete if the Publisher is the Data Processor rather than the data controller.
- If the Publisher is also the Data Controller please provide “Not Applicable”.
- **Examples**:
- Not Applicable
- SAIL', | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'null'] |
@@ -726,9 +725,9 @@ Section includes technical attributes for language vocabularies, sizes etc. and
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 | '- 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.\n- 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.\n- Notes: More than one vocabulary may be provided.\n- **Local**: Local Coding Standard\n- **OPCS4**: \n- **READ**: \n- **SNOMED CT**: \n- **SNOMED RT**: \n- **DM+D**: \n- **NHS National Codes**: \n- **ODS**: \n- **LOINC**: \n- **ICD10**: \n- **ICD10CM**: \n- **ICD10PCS**: \n- **ICD9CM**: \n- **ICD9**: \n- **ICDO3**: \n- **AMT**: \n- **APC**: \n- **ATC**: \n- **CIEL**: \n- **HPO**: \n- **CPT4**: \n- **DPD**: \n- **DRG**: \n- **HEMONC**: \n- **JMDC**: \n- **KCD7**: \n- **MULTUM**: \n- **NAACCR**: \n- **NDC**: \n- **NDFRT** <:https://www.nlm.nih.gov/research/umls/sourcereleasedocs/current/NDFRT/index.html>\n- **OXMIS**: \n- **RXNORM**: \n- **RXNORM EXTENSION**: \n- **SPL**: \n- **Other**: Please indicate if there is another standard that you are using. This will trigger a support ticket where you can request the addition of the terminology to the HOP.\n- **NHS Scotland National Codes**: \n- **NHS Wales National Codes**: ', | True | True | ["ControlledVocabulary[{'$defs': {'ControlledVocabularyEnum': {'enum': ['LOCAL', 'OPCS4', 'READ', 'SNOMED CT', 'SNOMED RT', 'DM PLUS D', 'DM+D', 'NHS NATIONAL CODES', 'NHS SCOTLAND NATIONAL CODES', 'NHS WALES NATIONAL CODES', 'ODS', 'LOINC', 'ICD10', 'ICD10CM', 'ICD10PCS', 'ICD9CM', 'ICD9', 'ICDO3', 'AMT', 'APC', 'ATC', 'CIEL', 'HPO', 'CPT4', 'DPD', 'DRG', 'HEMONC', 'JMDC', 'KCD7', 'MULTUM', 'NAACCR', 'NDC', 'NDFRT', 'OXMIS', 'RXNORM', 'RXNORM EXTENSION', 'SPL', 'OTHER'], 'title': 'ControlledVocabularyEnum', 'type': 'string'}}, 'anyOf': [{'$ref': '#/$defs/ControlledVocabularyEnum'}, {'type': 'null'}], 'default': null}]"] |
+| title | guidance | is_list | required | type |
+|:----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Controlled vocabulary | '- 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.
- **Local**: Local Coding Standard
- **OPCS4**:
- **READ**:
- **SNOMED CT**:
- **SNOMED RT**:
- **DM+D**:
- **NHS National Codes**:
- **ODS**:
- **LOINC**:
- **ICD10**:
- **ICD10CM**:
- **ICD10PCS**:
- **ICD9CM**:
- **ICD9**:
- **ICDO3**:
- **AMT**:
- **APC**:
- **ATC**:
- **CIEL**:
- **HPO**:
- **CPT4**:
- **DPD**:
- **DRG**:
- **HEMONC**:
- **JMDC**:
- **KCD7**:
- **MULTUM**:
- **NAACCR**:
- **NDC**:
- **NDFRT** <:https://www.nlm.nih.gov/research/umls/sourcereleasedocs/current/NDFRT/index.html>
- **OXMIS**:
- **RXNORM**:
- **RXNORM EXTENSION**:
- **SPL**:
- **Other**: Please indicate if there is another standard that you are using. This will trigger a support ticket where you can request the addition of the terminology to the HOP.
- **NHS Scotland National Codes**:
- **NHS Wales National Codes**: ', | True | True | ["ControlledVocabulary[{'$defs': {'ControlledVocabularyEnum': {'enum': ['LOCAL', 'OPCS4', 'READ', 'SNOMED CT', 'SNOMED RT', 'DM PLUS D', 'DM+D', 'NHS NATIONAL CODES', 'NHS SCOTLAND NATIONAL CODES', 'NHS WALES NATIONAL CODES', 'ODS', 'LOINC', 'ICD10', 'ICD10CM', 'ICD10PCS', 'ICD9CM', 'ICD9', 'ICDO3', 'AMT', 'APC', 'ATC', 'CIEL', 'HPO', 'CPT4', 'DPD', 'DRG', 'HEMONC', 'JMDC', 'KCD7', 'MULTUM', 'NAACCR', 'NDC', 'NDFRT', 'OXMIS', 'RXNORM', 'RXNORM EXTENSION', 'SPL', 'OTHER'], 'title': 'ControlledVocabularyEnum', 'type': 'string'}}, 'anyOf': [{'$ref': '#/$defs/ControlledVocabularyEnum'}, {'type': 'null'}], 'default': null}]"] |
@@ -737,9 +736,9 @@ List any relevant terminologies / ontologies / controlled vocabularies, such as
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 |
-|:----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| Alignment with standardised data models | '- List standardised data models that the dataset has been stored in or transformed to, such as OMOP or FHIR.\n- 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.\n- **HL7 FHIR**: \n- **HL7 V2**: \n- **HL7 CDA**: \n- **HL7 CCOW**: \n- **DICOM**: \n- **I2B2**: \n- **IHE**: \n- **OMOP**: \n- **openEHR**: \n- **Sentinel**: \n- **PCORnet**: \n- **CDISC**: \n- **Local**: In-house developed data model\n- **Other**: Other standardised data model\n- **NHS Data Dictionary**: \n- **NHS Scotland Data Dictionary**: \n- **NHS Wales Data Dictionary**: ', | 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}]"] |
+| title | guidance | is_list | required | type |
+|:----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Alignment with standardised data models | '- 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.
- **HL7 FHIR**:
- **HL7 V2**:
- **HL7 CDA**:
- **HL7 CCOW**:
- **DICOM**:
- **I2B2**:
- **IHE**:
- **OMOP**:
- **openEHR**:
- **Sentinel**:
- **PCORnet**:
- **CDISC**:
- **Local**: In-house developed data model
- **Other**: Other standardised data model
- **NHS Data Dictionary**:
- **NHS Scotland Data Dictionary**:
- **NHS Wales Data Dictionary**: ', | 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:
@@ -750,9 +749,9 @@ Examples:
This should list all the languages in which the dataset metadata and underlying data is made available.
-| title | guidance | is_list | required | type |
-|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------|
-| Language | - **aa**: Afar\n- **ab**: Abkhazian\n- **af**: Afrikaans\n- **ak**: Akan\n- **sq**: Albanian\n- **am**: Amharic\n- **ar**: Arabic\n- **an**: Aragonese\n- **hy**: Armenian\n- **as**: Assamese\n- **av**: Avaric\n- **ae**: Avestan\n- **ay**: Aymara\n- **az**: Azerbaijani\n- **ba**: Bashkir\n- **bm**: Bambara\n- **eu**: Basque\n- **be**: Belarusian\n- **bn**: Bengali\n- **bh**: Bihari languages\n- **bi**: Bislama\n- **bo**: Tibetan\n- **bs**: Bosnian\n- **br**: Breton\n- **bg**: Bulgarian\n- **my**: Burmese\n- **ca**: Catalan; Valencian\n- **cs**: Czech\n- **ch**: Chamorro\n- **ce**: Chechen\n- **zh**: Chinese\n- **cu**: Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic\n- **cv**: Chuvash\n- **kw**: Cornish\n- **co**: Corsican\n- **cr**: Cree\n- **cy**: Welsh\n- **cs**: Czech\n- **da**: Danish\n- **de**: German\n- **dv**: Divehi; Dhivehi; Maldivian\n- **nl**: Dutch; Flemish\n- **dz**: Dzongkha\n- **el**: Greek, Modern (1453-)\n- **en**: English\n- **eo**: Esperanto\n- **et**: Estonian\n- **eu**: Basque\n- **ee**: Ewe\n- **fo**: Faroese\n- **fa**: Persian\n- **fj**: Fijian\n- **fi**: Finnish\n- **fr**: French\n- **fy**: Western Frisian\n- **ff**: Fulah\n- **ka**: Georgian\n- **de**: German\n- **gd**: Gaelic; Scottish Gaelic\n- **ga**: Irish\n- **gl**: Galician\n- **gv**: Manx\n- **el**: Greek, Modern (1453-)\n- **gn**: Guarani\n- **gu**: Gujarati\n- **ht**: Haitian; Haitian Creole\n- **ha**: Hausa\n- **ho**: Hiri Motu\n- **hr**: Croatian\n- **hu**: Hungarian\n- **hy**: Armenian\n- **ig**: Igbo\n- **is**: Icelandic\n- **io**: Ido\n- **ii**: Sichuan Yi; Nuosu\n- **iu**: Inuktitut\n- **ie**: Interlingue; Occidental\n- **ia**: Interlingua (International Auxiliary Language Association)\n- **id**: Indonesian\n- **ik**: Inupiaq\n- **is**: Icelandic\n- **it**: Italian\n- **jv**: Javanese\n- **ja**: Japanese\n- **kl**: Kalaallisut; Greenlandic\n- **kn**: Kannada\n- **ks**: Kashmiri\n- **ka**: Georgian\n- **kr**: Kanuri\n- **kk**: Kazakh\n- **km**: Central Khmer\n- **ki**: Kikuyu; Gikuyu\n- **rw**: Kinyarwanda\n- **ky**: Kirghiz; Kyrgyz\n- **kv**: Komi\n- **kg**: Kongo\n- **ko**: Korean\n- **kj**: Kuanyama; Kwanyama\n- **ku**: Kurdish\n- **lo**: Lao\n- **la**: Latin\n- **lv**: Latvian\n- **li**: Limburgan; Limburger; limburgish\n- **ln**: Lingala\n- **lt**: Lithuanian\n- **lb**: Luxembourgish; Letzeburgesch\n- **lu**: Luba-Katanga\n- **lg**: Ganda\n- **mk**: Macedonian\n- **mh**: Marshallese\n- **ml**: Malayalam\n- **mi**: Maori\n- **mr**: Marathi\n- **ms**: Malay\n- **mk**: Macedonian\n- **mg**: Malagasy\n- **mt**: Maltese\n- **mn**: Mongolian\n- **mi**: Maori\n- **ms**: Malay\n- **my**: Burmese\n- **na**: Nauru\n- **nv**: Navajo; Navaho\n- **nr**: Ndebele, South; South Ndebele\n- **nd**: Ndebele, North; North Ndebele\n- **ng**: Ndonga\n- **ne**: Nepali\n- **nl**: Dutch; Flemish\n- **nn**: Norwegian Nynorsk; Nynorsk, Norwegian\n- **nb**: Bokmål, Norwegian; Norwegian Bokmål\n- **no**: Norwegian\n- **ny**: Chichewa; Chewa; Nyanja\n- **oc**: Occitan (post 1500)\n- **oj**: Ojibwa\n- **or**: Oriya\n- **om**: Oromo\n- **os**: Ossetian; Ossetic\n- **pa**: Panjabi; Punjabi\n- **fa**: Persian\n- **pi**: Pali\n- **pl**: Polish\n- **pt**: Portuguese\n- **ps**: Pushto; Pashto\n- **qu**: Quechua\n- **rm**: Romansh\n- **ro**: Romanian; Moldavian; Moldovan\n- **rn**: Rundi\n- **ru**: Russian\n- **sg**: Sango\n- **sa**: Sanskrit\n- **si**: Sinhala; Sinhalese\n- **sk**: Slovak\n- **sl**: Slovenian\n- **se**: Northern Sami\n- **sm**: Samoan\n- **sn**: Shona\n- **sd**: Sindhi\n- **so**: Somali\n- **st**: Sotho, Southern\n- **es**: Spanish; Castilian\n- **sq**: Albanian\n- **sc**: Sardinian\n- **sr**: Serbian\n- **ss**: Swati\n- **su**: Sundanese\n- **sw**: Swahili\n- **sv**: Swedish\n- **ty**: Tahitian\n- **ta**: Tamil\n- **tt**: Tatar\n- **te**: Telugu\n- **tg**: Tajik\n- **tl**: Tagalog\n- **th**: Thai\n- **bo**: Tibetan\n- **ti**: Tigrinya\n- **to**: Tonga (Tonga Islands)\n- **tn**: Tswana\n- **ts**: Tsonga\n- **tk**: Turkmen\n- **tr**: Turkish\n- **tw**: Twi\n- **ug**: Uighur; Uyghur\n- **uk**: Ukrainian\n- **ur**: Urdu\n- **uz**: Uzbek\n- **ve**: Venda\n- **vi**: Vietnamese\n- **vo**: Volapük\n- **cy**: Welsh\n- **wa**: Walloon\n- **wo**: Wolof\n- **xh**: Xhosa\n- **yi**: Yiddish\n- **yo**: Yoruba\n- **za**: Zhuang; Chuang\n- **zh**: Chinese\n- **zu**: Zulu', | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] |
+| title | guidance | is_list | required | type |
+|:---------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Language | - **aa**: Afar
- **ab**: Abkhazian
- **af**: Afrikaans
- **ak**: Akan
- **sq**: Albanian
- **am**: Amharic
- **ar**: Arabic
- **an**: Aragonese
- **hy**: Armenian
- **as**: Assamese
- **av**: Avaric
- **ae**: Avestan
- **ay**: Aymara
- **az**: Azerbaijani
- **ba**: Bashkir
- **bm**: Bambara
- **eu**: Basque
- **be**: Belarusian
- **bn**: Bengali
- **bh**: Bihari languages
- **bi**: Bislama
- **bo**: Tibetan
- **bs**: Bosnian
- **br**: Breton
- **bg**: Bulgarian
- **my**: Burmese
- **ca**: Catalan; Valencian
- **cs**: Czech
- **ch**: Chamorro
- **ce**: Chechen
- **zh**: Chinese
- **cu**: Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic
- **cv**: Chuvash
- **kw**: Cornish
- **co**: Corsican
- **cr**: Cree
- **cy**: Welsh
- **cs**: Czech
- **da**: Danish
- **de**: German
- **dv**: Divehi; Dhivehi; Maldivian
- **nl**: Dutch; Flemish
- **dz**: Dzongkha
- **el**: Greek, Modern (1453-)
- **en**: English
- **eo**: Esperanto
- **et**: Estonian
- **eu**: Basque
- **ee**: Ewe
- **fo**: Faroese
- **fa**: Persian
- **fj**: Fijian
- **fi**: Finnish
- **fr**: French
- **fy**: Western Frisian
- **ff**: Fulah
- **ka**: Georgian
- **de**: German
- **gd**: Gaelic; Scottish Gaelic
- **ga**: Irish
- **gl**: Galician
- **gv**: Manx
- **el**: Greek, Modern (1453-)
- **gn**: Guarani
- **gu**: Gujarati
- **ht**: Haitian; Haitian Creole
- **ha**: Hausa
- **ho**: Hiri Motu
- **hr**: Croatian
- **hu**: Hungarian
- **hy**: Armenian
- **ig**: Igbo
- **is**: Icelandic
- **io**: Ido
- **ii**: Sichuan Yi; Nuosu
- **iu**: Inuktitut
- **ie**: Interlingue; Occidental
- **ia**: Interlingua (International Auxiliary Language Association)
- **id**: Indonesian
- **ik**: Inupiaq
- **is**: Icelandic
- **it**: Italian
- **jv**: Javanese
- **ja**: Japanese
- **kl**: Kalaallisut; Greenlandic
- **kn**: Kannada
- **ks**: Kashmiri
- **ka**: Georgian
- **kr**: Kanuri
- **kk**: Kazakh
- **km**: Central Khmer
- **ki**: Kikuyu; Gikuyu
- **rw**: Kinyarwanda
- **ky**: Kirghiz; Kyrgyz
- **kv**: Komi
- **kg**: Kongo
- **ko**: Korean
- **kj**: Kuanyama; Kwanyama
- **ku**: Kurdish
- **lo**: Lao
- **la**: Latin
- **lv**: Latvian
- **li**: Limburgan; Limburger; limburgish
- **ln**: Lingala
- **lt**: Lithuanian
- **lb**: Luxembourgish; Letzeburgesch
- **lu**: Luba-Katanga
- **lg**: Ganda
- **mk**: Macedonian
- **mh**: Marshallese
- **ml**: Malayalam
- **mi**: Maori
- **mr**: Marathi
- **ms**: Malay
- **mk**: Macedonian
- **mg**: Malagasy
- **mt**: Maltese
- **mn**: Mongolian
- **mi**: Maori
- **ms**: Malay
- **my**: Burmese
- **na**: Nauru
- **nv**: Navajo; Navaho
- **nr**: Ndebele, South; South Ndebele
- **nd**: Ndebele, North; North Ndebele
- **ng**: Ndonga
- **ne**: Nepali
- **nl**: Dutch; Flemish
- **nn**: Norwegian Nynorsk; Nynorsk, Norwegian
- **nb**: Bokmål, Norwegian; Norwegian Bokmål
- **no**: Norwegian
- **ny**: Chichewa; Chewa; Nyanja
- **oc**: Occitan (post 1500)
- **oj**: Ojibwa
- **or**: Oriya
- **om**: Oromo
- **os**: Ossetian; Ossetic
- **pa**: Panjabi; Punjabi
- **fa**: Persian
- **pi**: Pali
- **pl**: Polish
- **pt**: Portuguese
- **ps**: Pushto; Pashto
- **qu**: Quechua
- **rm**: Romansh
- **ro**: Romanian; Moldavian; Moldovan
- **rn**: Rundi
- **ru**: Russian
- **sg**: Sango
- **sa**: Sanskrit
- **si**: Sinhala; Sinhalese
- **sk**: Slovak
- **sl**: Slovenian
- **se**: Northern Sami
- **sm**: Samoan
- **sn**: Shona
- **sd**: Sindhi
- **so**: Somali
- **st**: Sotho, Southern
- **es**: Spanish; Castilian
- **sq**: Albanian
- **sc**: Sardinian
- **sr**: Serbian
- **ss**: Swati
- **su**: Sundanese
- **sw**: Swahili
- **sv**: Swedish
- **ty**: Tahitian
- **ta**: Tamil
- **tt**: Tatar
- **te**: Telugu
- **tg**: Tajik
- **tl**: Tagalog
- **th**: Thai
- **bo**: Tibetan
- **ti**: Tigrinya
- **to**: Tonga (Tonga Islands)
- **tn**: Tswana
- **ts**: Tsonga
- **tk**: Turkmen
- **tr**: Turkish
- **tw**: Twi
- **ug**: Uighur; Uyghur
- **uk**: Ukrainian
- **ur**: Urdu
- **uz**: Uzbek
- **ve**: Venda
- **vi**: Vietnamese
- **vo**: Volapük
- **cy**: Welsh
- **wa**: Walloon
- **wo**: Wolof
- **xh**: Xhosa
- **yi**: Yiddish
- **yo**: Yoruba
- **za**: Zhuang; Chuang
- **zh**: Chinese
- **zu**: Zulu', | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] |
@@ -761,9 +760,9 @@ This should list all the languages in which the dataset metadata and underlying
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 | '- If multiple formats are available, please specify. See application, audio, image, message, model, multipart, text, video, \n- Please **enter one format type at a time** and click **Add New Field** to add further keywords.\n- Note: If your file format is not included in the current list of formats, please indicate other.\n- If you are using the HOP, you will be directed to a service desk page where you can request your additional format.\n- If not, please go to: to request your format.\n- **Example**: text/tab-separated-values, application/sql, text/csv, image/diacom-rle', | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] |
+| title | guidance | is_list | required | type |
+|:--------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Format | '- If multiple formats are available, please specify. See application, audio, image, message, model, multipart, text, video,
- Please **enter one format type at a time** and click **Add New Field** to add further keywords.
- 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: to request your format.
- **Example**: text/tab-separated-values, application/sql, text/csv, image/diacom-rle', | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] |
@@ -949,12 +948,9 @@ None
Please provide link to any active projects that are using the dataset.
-| title | guidance | is_list | required | type |
-|:---------------|:----------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------|
-| Investigations | - Please provide the website address(es) which document information related to active projects utilising the dataset. | True | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] |
-| | - Please split your existing list of citations into separate fields. | | | |
-| | - To add multiple entries, please click on **'+' symbol** to enter each separate website. | | | |
-| | - **Example**: | | | |
+| title | guidance | is_list | required | type |
+|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------|
+| Investigations | - Please provide the website address(es) which document information related to active projects utilising the dataset.
- Please split your existing list of citations into separate fields.
- To add multiple entries, please click on **'+' symbol** to enter each separate website.
- **Example**: | True | False | ["Url[{'anyOf': [{'format': 'uri', 'minLength': 1, 'type': 'string'}, {'type': 'null'}]}]"] |
@@ -974,12 +970,9 @@ Please provide the URL of any analysis tools or models that have been created fo
DOIs for publications which describe the dataset.
-| title | guidance | is_list | required | type |
-|:------------------------------|:-------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------|
-| Publication about the dataset | - Please provide the DOIs for publications which describe the dataset. | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] |
-| | - Please split your existing list of citations into separate fields. | | | |
-| | - To add multiple entries, please click on **'+' symbol** to enter each separate citation. | | | |
-| | - **Example**: | | | |
+| title | guidance | is_list | required | type |
+|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------|
+| Publication about the dataset | - Please provide the DOIs for publications which describe the dataset.
- Please split your existing list of citations into separate fields.
- To add multiple entries, please click on **'+' symbol** to enter each separate citation.
- **Example**: | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] |
@@ -988,25 +981,16 @@ DOIs for publications which describe the dataset.
DOIs for publications which use the dataset for analysis.
-| title | guidance | is_list | required | type |
-|:------------------------------|:-------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------|
-| Publication using the dataset | - Please provide the DOIs for publications which have used the dataset in their analysis. | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]"] |
-| | - Please split your existing list of citations into separate fields. | | | |
-| | - To add multiple entries, please click on **'+' symbol** to enter each separate citation. | | | |
-| | - **Example**: . | | | |
+| title | guidance | is_list | required | type |
+|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------|
+| Publication using the dataset | - Please provide the DOIs for publications which have used the dataset in their analysis.
- Please split your existing list of citations into separate fields.
- To add multiple entries, please click on **'+' symbol** to enter each separate citation.
- **Example**: . | True | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', '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”"
-
+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”"
@@ -1017,9 +1001,9 @@ Example:
Please select one of the following statistical populations for you observation.
-| title | guidance | is_list | required | type |
-|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------|
-| Dataset volume measure | - **Persons**: Unique persons recorded in the dataset\n- **Events**: Unique events such as procedures and prescriptions within the dataset\n - **Findings**: Unique findings included in the dataset such as diagnoses, test '\n-**Number of scans per modality**: Unique scans for a specified modality (e.g. 12 x-rays) | False | True | ["StatisticalPopulationConstrainedV2['Person','Event','Findings','Number of scans per modality']"] |
+| title | guidance | is_list | required | type |
+|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:---------------------------------------------------------------------------------------------------|
+| Dataset volume measure | - **Persons**: Unique persons recorded in the dataset
- **Events**: Unique events such as procedures and prescriptions within the dataset
- **Findings**: Unique findings included in the dataset such as diagnoses, test '
-**Number of scans per modality**: Unique scans for a specified modality (e.g. 12 x-rays) | False | True | ["StatisticalPopulationConstrainedV2['Person','Event','Findings','Number of scans per modality']"] |
Examples:
@@ -1030,9 +1014,9 @@ 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 | guidance | is_list | required | type |
-|:---------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------|
-| Measured value | - Please provide the dataset size associated with the volume measure type.\n- You can add more than one volume measure by clicking the '+' symbol.\n **Example**: 1000 people in a study, or 87 images (MRI) of Knee. | False | True | ['int'] |
+| title | guidance | is_list | required | type |
+|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------|
+| Measured value | - Please provide the dataset size associated with the volume measure type.
- You can add more than one volume measure by clicking the '+' symbol.
**Example**: 1000 people in a study, or 87 images (MRI) of Knee. | False | True | ['int'] |
diff --git a/docs/HDRUK/3.0.0.structure.json b/docs/HDRUK/3.0.0.structure.json
index cdae6cf..06e848e 100644
--- a/docs/HDRUK/3.0.0.structure.json
+++ b/docs/HDRUK/3.0.0.structure.json
@@ -23,7 +23,7 @@
"required": true,
"title": "Dataset Version",
"description": "Dataset metadata version.",
- "guidance": "Dataset metadata version should follow standard SEMVER naming conventions(https://semver.org). For example: 1.1.0 major.minor.patch. Major: Significant/breaking changes. Minor: New features and bug fixes. Patch: Minor fixes without new features.",
+ "guidance": "Dataset metadata version should follow standard SEMVER naming conventions(https://semver.org). For example: 1.1.0 major.minor.patch.Major: Significant/breaking changes.Minor: New features and bug fixes.Patch: Minor fixes without new features.",
"examples": [
"1.1.0"
],
@@ -126,7 +126,7 @@
"required": true,
"title": "Title",
"description": "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.",
- "guidance": "The title 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. - If the dataset is a \u201clinked dataset\u201d, please indicate this using the prefix \u201cLinked\u201d. - Please avoid acronyms wherever possible. - Good titles should summarise the content of the dataset and if relevant, the region the dataset covers. - Example: North West London COVID-19 Patient Level Situation Report",
+ "guidance": "The title 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.- If the dataset is a \u201clinked dataset\u201d, please indicate this using the prefix \u201cLinked\u201d.- Please avoid acronyms wherever possible.- Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.- Example: North West London COVID-19 Patient Level Situation Report",
"examples": [
"North West London COVID-19 Patient Level Situation Report"
],
@@ -234,7 +234,7 @@
"examples": null,
"type": [
"EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]",
- "List"
+ "typing.List[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]"
],
"is_list": false,
"is_optional": false,
@@ -280,7 +280,7 @@
],
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]",
"null"
],
"is_list": false,
@@ -329,7 +329,7 @@
"examples": null,
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]",
"null"
],
"is_list": false,
@@ -377,7 +377,7 @@
],
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]",
"null"
],
"is_list": false,
@@ -425,7 +425,7 @@
],
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List"
+ "typing.List[hdr_schemata.definitions.HDRUK.Url.Url]"
],
"is_list": false,
"is_optional": false,
@@ -795,7 +795,7 @@
"examples": null,
"type": [
"ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]",
"null"
],
"is_list": false,
@@ -916,7 +916,7 @@
"examples": null,
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]",
"null"
],
"is_list": false,
@@ -1008,7 +1008,7 @@
"examples": null,
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[hdr_schemata.definitions.HDRUK.Language.Language]",
"null"
],
"is_list": false,
@@ -1024,7 +1024,7 @@
"examples": null,
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
- "List",
+ "typing.List[hdr_schemata.definitions.HDRUK.Format.Format]",
"null"
],
"is_list": false,
diff --git a/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml b/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml
index 2f7a011..da2f7fc 100644
--- a/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml
+++ b/hdr_schemata/models/HDRUK/v3_0_0/annotations/config.yaml
@@ -21,13 +21,7 @@ summary:
title: "Keywords"
description: "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: >
- - The **title** 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.
- - If the dataset is a **“linked dataset”**, please indicate this using the prefix **“Linked”**.
- - Please **avoid acronyms** wherever possible.
- - Good titles should summarise the content of the dataset and if relevant, **the region the dataset covers**.
- - **Example**: North West London COVID-19 Patient Level Situation Report
+ guidance: "- The **title** should provide a short description of the dataset and be **unique** across the gateway.\\n- 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.\\n- If the dataset is a **“linked dataset”**, please indicate this using the prefix **“Linked”**.\\n- Please **avoid acronyms** wherever possible.\\n- Good titles should summarise the content of the dataset and if relevant, **the region the dataset covers**.\\n- **Example**: North West London COVID-19 Patient Level Situation Report"
examples:
- "North West London COVID-19 Patient Level Situation Report"
title: "Title"
@@ -370,11 +364,7 @@ identifier:
title: "Dataset identifier"
description: "System dataset identifier."
version:
- guidance: >
- Dataset metadata version should follow standard SEMVER naming conventions(https://semver.org). For example: 1.1.0 major.minor.patch.
- Major: Significant/breaking changes.
- Minor: New features and bug fixes.
- Patch: Minor fixes without new features.
+ guidance: "Dataset metadata version should follow standard SEMVER naming conventions(https://semver.org). For example: 1.1.0 major.minor.patch.\\nMajor: Significant/breaking changes.\\nMinor: New features and bug fixes.\\nPatch: Minor fixes without new features."
examples:
- "1.1.0"
title: "Dataset Version"
diff --git a/hdr_schemata/utils/create_markdown.py b/hdr_schemata/utils/create_markdown.py
index 8a5f6ad..b060d26 100644
--- a/hdr_schemata/utils/create_markdown.py
+++ b/hdr_schemata/utils/create_markdown.py
@@ -6,6 +6,7 @@
import enum
import os
from markdown_cleaner import clean_markdown_from_json
+from markdown_cleaner import replace_new_lines_with_breaks
dir_path = os.path.dirname(os.path.realpath(__file__))
@@ -109,6 +110,7 @@ def get_fields(structure, model: type[BaseModel]):
def json_to_markdown(structure, level=2):
md = ""
+ structure = replace_new_lines_with_breaks(structure)
for field in structure:
name = field.pop("name")
subItems = field.pop("subItems", None)
@@ -214,12 +216,13 @@ def remove_types(data):
structure = []
get_fields(structure, Model)
+
form = {}
form["schema_fields"] = []
form_structure(structure, form)
with open(f"{path}/{name}.form.json", "w") as f:
json.dump(form, f, indent=6)
-
+
with open(f"{path}/{name}.structure.json", "w") as f:
remove_types(structure)
json.dump(clean_markdown_from_json(structure), f, indent=6)
diff --git a/hdr_schemata/utils/markdown_cleaner.py b/hdr_schemata/utils/markdown_cleaner.py
index 6cf1370..52db44c 100644
--- a/hdr_schemata/utils/markdown_cleaner.py
+++ b/hdr_schemata/utils/markdown_cleaner.py
@@ -14,5 +14,15 @@ def clean_markdown_from_json(data, key=None):
text = "".join(BeautifulSoup(html, features='html.parser').findAll(text=True))
nl_clean = re.sub(r'(\r\n|\r|\n|\\n)', '', text)
return nl_clean
+ else:
+ return data
+
+def replace_new_lines_with_breaks(data, key=None):
+ if isinstance(data, dict):
+ return {k: replace_new_lines_with_breaks(v, k) for k, v in data.items()}
+ elif isinstance(data, list):
+ return [replace_new_lines_with_breaks(v, key) for v in data]
+ elif isinstance(data, str):
+ return re.sub(r'(\r\n|\r|\n|\\n)', '
', data)
else:
return data
\ No newline at end of file