From ce2a246346285f6c749b994b3c7232a9d35c6c77 Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Wed, 14 Aug 2024 15:11:07 +0100 Subject: [PATCH 1/7] allow material type to be null --- hdr_schemata/models/HDRUK/3.0.0/schema.json | 17 +++++++--- hdr_schemata/models/HDRUK/v3_0_0/Coverage.py | 33 ++++++++++++-------- 2 files changed, 32 insertions(+), 18 deletions(-) diff --git a/hdr_schemata/models/HDRUK/3.0.0/schema.json b/hdr_schemata/models/HDRUK/3.0.0/schema.json index fa575c9..5e329fb 100644 --- a/hdr_schemata/models/HDRUK/3.0.0/schema.json +++ b/hdr_schemata/models/HDRUK/3.0.0/schema.json @@ -370,14 +370,21 @@ "title": "Dataset coverage/completeness/quality" }, "materialType": { + "anyOf": [ + { + "items": { + "$ref": "#/$defs/MaterialTypeCategoriesV2" + }, + "type": "array" + }, + { + "type": "null" + } + ], "default": "None/not available", "description": "The type of biospecimen saved from a biological entity.", "guidance": "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 \u201cAvailability to be confirmed\u201d.- If samples are not available, then please provide \u201cNot available\u201d.- 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.", - "items": { - "$ref": "#/$defs/MaterialTypeCategoriesV2" - }, - "title": "Biological sample availability", - "type": "array" + "title": "Biological sample availability" }, "followup": { "anyOf": [ diff --git a/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py b/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py index 8d0eb84..234c11f 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py +++ b/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py @@ -12,32 +12,39 @@ class Coverage(BaseModel): class Config: extra = "forbid" - - spatial: Union[CommaSeparatedValues, List[Url]] = ( - Field(None, **an.spatial.__dict__, json_schema_extra={"guidance": an.spatial.guidance}) + + spatial: Union[CommaSeparatedValues, List[Url]] = Field( + None, **an.spatial.__dict__, json_schema_extra={"guidance": an.spatial.guidance} ) typicalAgeRangeMin: Optional[int] = Field( - None, **an.typicalAgeRangeMin.__dict__, json_schema_extra={"guidance": an.typicalAgeRangeMin.guidance} + None, + **an.typicalAgeRangeMin.__dict__, + json_schema_extra={"guidance": an.typicalAgeRangeMin.guidance} ) typicalAgeRangeMax: Optional[int] = Field( - None, **an.typicalAgeRangeMax.__dict__, json_schema_extra={"guidance": an.typicalAgeRangeMax.guidance} + None, + **an.typicalAgeRangeMax.__dict__, + json_schema_extra={"guidance": an.typicalAgeRangeMax.guidance} ) - datasetCompleteness: Optional[Url] = ( - Field( - None, - **an.datasetCompleteness.__dict__, - json_schema_extra={"guidance": an.datasetCompleteness.guidance}) + datasetCompleteness: Optional[Url] = Field( + None, + **an.datasetCompleteness.__dict__, + json_schema_extra={"guidance": an.datasetCompleteness.guidance} ) - materialType: List[MaterialTypeCategoriesV2] = Field( - "None/not available", **an.materialType.__dict__, json_schema_extra={"guidance": an.materialType.guidance} + materialType: Optional[List[MaterialTypeCategoriesV2]] = Field( + "None/not available", + **an.materialType.__dict__, + json_schema_extra={"guidance": an.materialType.guidance} ) followup: Optional[Followup] = Field( - "UNKNOWN", **an.followup.__dict__, json_schema_extra={"guidance": an.followup.guidance} + "UNKNOWN", + **an.followup.__dict__, + json_schema_extra={"guidance": an.followup.guidance} ) pathway: Optional[Description] = Field( From 6e39743c8794de2a0d1647c174a247e60c4d7a06 Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Wed, 14 Aug 2024 15:17:01 +0100 Subject: [PATCH 2/7] fix --- hdr_schemata/models/HDRUK/3.0.0/schema.json | 2 +- hdr_schemata/models/HDRUK/v3_0_0/Coverage.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/hdr_schemata/models/HDRUK/3.0.0/schema.json b/hdr_schemata/models/HDRUK/3.0.0/schema.json index 5e329fb..76779a2 100644 --- a/hdr_schemata/models/HDRUK/3.0.0/schema.json +++ b/hdr_schemata/models/HDRUK/3.0.0/schema.json @@ -381,7 +381,7 @@ "type": "null" } ], - "default": "None/not available", + "default": null, "description": "The type of biospecimen saved from a biological entity.", "guidance": "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 \u201cAvailability to be confirmed\u201d.- If samples are not available, then please provide \u201cNot available\u201d.- 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.", "title": "Biological sample availability" diff --git a/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py b/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py index 234c11f..06c99a3 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py +++ b/hdr_schemata/models/HDRUK/v3_0_0/Coverage.py @@ -36,7 +36,7 @@ class Config: ) materialType: Optional[List[MaterialTypeCategoriesV2]] = Field( - "None/not available", + None, **an.materialType.__dict__, json_schema_extra={"guidance": an.materialType.guidance} ) From 27f52ee530682b03dc7c693815e07aeebeebaff2 Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Thu, 15 Aug 2024 12:21:05 +0100 Subject: [PATCH 3/7] fix format and standards --- .../models/HDRUK/v3_0_0/FormatAndStandards.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py b/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py index d3345d8..6dd888d 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py +++ b/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py @@ -12,19 +12,23 @@ class Config: extra = "forbid" vocabularyEncodingScheme: List[ControlledVocabulary] = Field( - ..., - **an.vocabularyEncodingScheme.__dict__, + ..., + **an.vocabularyEncodingScheme.__dict__, json_schema_extra={"guidance": an.vocabularyEncodingScheme.guidance} ) conformsTo: List[StandardisedDataModels] = Field( - ..., **an.conformsTo.__dict__, json_schema_extra={"guidance": an.conformsTo.guidance} + ..., + **an.conformsTo.__dict__, + json_schema_extra={"guidance": an.conformsTo.guidance} ) - language: Union[Optional[CommaSeparatedValues], List[Language]] = Field( - ..., **an.language.__dict__, json_schema_extra={"guidance": an.language.guidance} + language: List[Language] = Field( + ..., + **an.language.__dict__, + json_schema_extra={"guidance": an.language.guidance} ) - format: Union[Optional[CommaSeparatedValues], List[Format]] = Field( + format: List[Format] = Field( ..., **an.format.__dict__, json_schema_extra={"guidance": an.format.guidance} ) From 797f84fafee6523938db89ecd81c80bbaf0210aa Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Thu, 15 Aug 2024 12:31:27 +0100 Subject: [PATCH 4/7] fix format and standards --- hdr_schemata/definitions/HDRUK/__init__.py | 7 +- hdr_schemata/models/HDRUK/3.0.0/schema.json | 90 ++++--------------- .../models/HDRUK/v3_0_0/FormatAndStandards.py | 14 +-- 3 files changed, 28 insertions(+), 83 deletions(-) diff --git a/hdr_schemata/definitions/HDRUK/__init__.py b/hdr_schemata/definitions/HDRUK/__init__.py index 0af2bff..07527d5 100644 --- a/hdr_schemata/definitions/HDRUK/__init__.py +++ b/hdr_schemata/definitions/HDRUK/__init__.py @@ -20,7 +20,7 @@ from .IsPartOfEnum import IsPartOfEnum from .Isocountrycode import Isocountrycode from .Language import Language -from .LanguageEnum import LanguageEnum +from .Language import LanguageEnum from .LongAbstractText import LongAbstractText from .LongDescription import LongDescription from .MaterialTypeCategories import MaterialTypeCategories, MaterialTypeCategoriesV2 @@ -39,7 +39,10 @@ from .Source import Source, SourceV2 from .StandardisedDataModels import StandardisedDataModels from .StandardisedDataModelsEnum import StandardisedDataModelsEnum -from .StatisticalPopulationConstrained import StatisticalPopulationConstrained, StatisticalPopulationConstrainedV2 +from .StatisticalPopulationConstrained import ( + StatisticalPopulationConstrained, + StatisticalPopulationConstrainedV2, +) from .Ternary import Ternary from .TimeLag import TimeLag, TimeLagV2 from .TissueCollectionTypeEnum import TissueCollectionTypeEnum diff --git a/hdr_schemata/models/HDRUK/3.0.0/schema.json b/hdr_schemata/models/HDRUK/3.0.0/schema.json index 76779a2..21292a3 100644 --- a/hdr_schemata/models/HDRUK/3.0.0/schema.json +++ b/hdr_schemata/models/HDRUK/3.0.0/schema.json @@ -239,18 +239,6 @@ ], "title": "CommaSeparatedValues" }, - "ControlledVocabulary": { - "anyOf": [ - { - "$ref": "#/$defs/ControlledVocabularyEnum" - }, - { - "type": "null" - } - ], - "default": null, - "title": "ControlledVocabulary" - }, "ControlledVocabularyEnum": { "enum": [ "LOCAL", @@ -1041,60 +1029,40 @@ "additionalProperties": false, "properties": { "vocabularyEncodingScheme": { + "default": null, "description": "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 \u201cother\u201d and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.", "guidance": "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 \u201cother\u201d and contact support desk to ask for an addition.- Notes: More than one vocabulary may be provided.- Local: Local Coding Standard.- OPCS4: https://www.datadictionary.nhs.uk/web_site_content/supporting_information/clinical_coding/opcs_classification_of_interventions_and_procedures.asp.- READ: https://digital.nhs.uk/services/terminology-and-classifications/read-codes.- SNOMED CT: http://www.snomed.org/.- SNOMED RT: https://confluence.ihtsdotools.org/display/DOCGLOSS/SNOMED+RT.- DM+D: https://digital.nhs.uk/data-and-information/information-standards/information-standards-and-data-collections-including-extractions/publications-and-notifications/standards-and-collections/scci0052-dictionary-of-medicines-and-devices-dm-d.- NHS National Codes: https://www.datadictionary.nhs.uk/.- ODS: https://digital.nhs.uk/services/organisation-data-service.- LOINC: https://loinc.org/.- ICD10: https://www.who.int/classifications/icd/icdonlineversions/en/.- ICD10CM: https://www.cdc.gov/nchs/icd/icd10cm.htm.- ICD10PCS: https://ec.europa.eu/eip/ageing/standards/healthcare/e-health/icd-10-pcs_en.- ICD9CM: https://www.cdc.gov/nchs/icd/icd9cm.htm.- ICD9: https://www.cdc.gov/nchs/icd/icd9.htm.- ICDO3: https://www.who.int/classifications/icd/adaptations/oncology/en/.- AMT: https://www.digitalhealth.gov.au/about-the-agency/tenders-and-offers/community-pharmacy-software-industry-partnership-offer/Webinar%20-%20Australian%20Medicines%20Terminology%20(AMT)%20and%20Implementation%20Options%2001032017.pdf.- APC: https://www.acep.org/administration/reimbursement/reimbursement-faqs/apc-ambulatory-payment-classifications-faq/.- ATC: https://www.whocc.no/atc_ddd_index/.- CIEL: https://github.com/OpenConceptLab/ocl_web/wiki/CIEL.- HPO: https://hpo.jax.org/app/.- CPT4: https://www.cms.gov/Regulations-and-Guidance/Legislation/CLIA/Downloads/SubjecttoCLIA.pdf.- DPD: https://health-products.canada.ca/dpd-bdpp/index-eng.jsp.- DRG: http://www.euro.who.int/__data/assets/pdf_file/0004/162265/e96538.pdf.- HEMONC: https://hemonc.org/wiki/Main_Page.- JMDC: https://www.jmdc.co.jp/en/.- KCD7: https://forums.ohdsi.org/t/adding-kcd7-code-korean-icd-10-to-the-omop-vocabulary/7576.- MULTUM: https://www.cerner.com/solutions/drug-database.- NAACCR: https://www.naaccr.org/.- NDC: https://www.fda.gov/drugs/drug-approvals-and-databases/national-drug-code-directory.- NDFRT <:https://www.nlm.nih.gov/research/umls/sourcereleasedocs/current/NDFRT/index.html>.- OXMIS: https://oxrisk.com/oxmis/.- RXNORM: https://www.nlm.nih.gov/research/umls/rxnorm/index.html.- RXNORM EXTENSION: https://www.nlm.nih.gov/research/umls/rxnorm/index.html.- SPL: https://www.fda.gov/industry/fda-resources-data-standards/structured-product-labeling-resources.- 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: https://www.ndc.scot.nhs.uk/Data-Dictionary/.- NHS Wales National Codes: http://www.datadictionary.wales.nhs.uk/", "items": { - "$ref": "#/$defs/ControlledVocabulary" + "$ref": "#/$defs/ControlledVocabularyEnum" }, "title": "Controlled vocabulary", "type": "array" }, "conformsTo": { + "default": null, "description": "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 \u201cother\u201d and contact support desk to ask for an addition.", "examples": [ "LOCAL,NHS DATA DICTIONARY" ], "guidance": "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 \u201cother\u201d and contact support desk to ask for an addition.- HL7 FHIR: https://www.hl7.org/fhir/.- HL7 V2: https://www.hl7.org/implement/standards/product_section.cfm?section=13.- HL7 CDA: https://www.hl7.org/implement/standards/product_section.cfm?section=10.- HL7 CCOW: https://www.hl7.org/implement/standards/product_section.cfm?section=16.- DICOM: https://www.dicomstandard.org/.- I2B2: https://www.i2b2.org/.- IHE: https://www.ihe.net/resources/profiles/.- OMOP: https://www.ohdsi.org/data-standardization/the-common-data-model/.- openEHR: https://www.openehr.org/.- Sentinel: https://www.sentinelinitiative.org/sentinel/data/distributed-database-common-data-model.- PCORnet: https://pcornet.org/data-driven-common-model/.- CDISC: https://www.cdisc.org/standards/data-exchange/odm.- Local: In-house developed data model.- Other: Other standardised data model.- NHS Data Dictionary: https://www.datadictionary.nhs.uk/.- NHS Scotland Data Dictionary: https://www.ndc.scot.nhs.uk/Data-Dictionary/.- NHS Wales Data Dictionary: https://www.datadictionary.wales.nhs.uk/.", "items": { - "$ref": "#/$defs/StandardisedDataModels" + "$ref": "#/$defs/StandardisedDataModelsEnum" }, "title": "Alignment with standardised data models", "type": "array" }, "language": { - "anyOf": [ - { - "$ref": "#/$defs/CommaSeparatedValues" - }, - { - "items": { - "$ref": "#/$defs/Language" - }, - "type": "array" - }, - { - "type": "null" - } - ], + "default": null, "description": "This should list all the languages in which the dataset metadata and underlying data is made available complaint with ISO 639.", "guidance": "https://www.iso.org/iso-639-language-code- 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\u00e5l, Norwegian; Norwegian Bokm\u00e5l- 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\u00fck- cy: Welsh- wa: Walloon- wo: Wolof- xh: Xhosa- yi: Yiddish- yo: Yoruba- za: Zhuang; Chuang- zh: Chinese- zu: Zulu", - "title": "Language" + "items": { + "$ref": "#/$defs/LanguageEnum" + }, + "title": "Language", + "type": "array" }, "format": { - "anyOf": [ - { - "$ref": "#/$defs/CommaSeparatedValues" - }, - { - "items": { - "$ref": "#/$defs/Format" - }, - "type": "array" - }, - { - "type": "null" - } - ], + "default": null, "description": "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.", "examples": [ "text/tab-separated-values", @@ -1103,15 +1071,13 @@ "image/diacom-rle" ], "guidance": "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.- 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.- Example: text/tab-separated-values, application/sql, text/csv, image/diacom-rle", - "title": "Format" + "items": { + "$ref": "#/$defs/Format" + }, + "title": "Format", + "type": "array" } }, - "required": [ - "vocabularyEncodingScheme", - "conformsTo", - "language", - "format" - ], "title": "FormatAndStandards", "type": "object" }, @@ -1129,18 +1095,6 @@ "title": "Isocountrycode", "type": "string" }, - "Language": { - "anyOf": [ - { - "$ref": "#/$defs/LanguageEnum" - }, - { - "type": "null" - } - ], - "default": null, - "title": "Language" - }, "LanguageEnum": { "enum": [ "aa", @@ -1828,18 +1782,6 @@ "title": "SourceV2", "type": "string" }, - "StandardisedDataModels": { - "anyOf": [ - { - "$ref": "#/$defs/StandardisedDataModelsEnum" - }, - { - "type": "null" - } - ], - "default": null, - "title": "StandardisedDataModels" - }, "StandardisedDataModelsEnum": { "enum": [ "HL7 FHIR", diff --git a/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py b/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py index 6dd888d..4ac4cdc 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py +++ b/hdr_schemata/models/HDRUK/v3_0_0/FormatAndStandards.py @@ -11,24 +11,24 @@ class FormatAndStandards(BaseModel): class Config: extra = "forbid" - vocabularyEncodingScheme: List[ControlledVocabulary] = Field( - ..., + vocabularyEncodingScheme: List[ControlledVocabularyEnum] = Field( + None, **an.vocabularyEncodingScheme.__dict__, json_schema_extra={"guidance": an.vocabularyEncodingScheme.guidance} ) - conformsTo: List[StandardisedDataModels] = Field( - ..., + conformsTo: List[StandardisedDataModelsEnum] = Field( + None, **an.conformsTo.__dict__, json_schema_extra={"guidance": an.conformsTo.guidance} ) - language: List[Language] = Field( - ..., + language: List[LanguageEnum] = Field( + None, **an.language.__dict__, json_schema_extra={"guidance": an.language.guidance} ) format: List[Format] = Field( - ..., **an.format.__dict__, json_schema_extra={"guidance": an.format.guidance} + None, **an.format.__dict__, json_schema_extra={"guidance": an.format.guidance} ) From e36afd711d14dad5fcd961e90dc1126487a0f675 Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Thu, 15 Aug 2024 14:00:49 +0100 Subject: [PATCH 5/7] fix null values --- hdr_schemata/models/HDRUK/3.0.0/schema.json | 8 +++----- hdr_schemata/models/HDRUK/v3_0_0/Temporal.py | 18 +++++++++++++----- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/hdr_schemata/models/HDRUK/3.0.0/schema.json b/hdr_schemata/models/HDRUK/3.0.0/schema.json index 21292a3..5720f8e 100644 --- a/hdr_schemata/models/HDRUK/3.0.0/schema.json +++ b/hdr_schemata/models/HDRUK/3.0.0/schema.json @@ -2001,6 +2001,7 @@ "$ref": "#/$defs/PeriodicityV2" } ], + "default": null, "description": "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 \u201con-demand\u201d 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/", "guidance": "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 \u201con-demand\u201d 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/. Options:- 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.", "title": "Publishing frequency" @@ -2035,6 +2036,7 @@ "type": "string" } ], + "default": null, "description": "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.", "guidance": "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": "Start date" @@ -2067,16 +2069,12 @@ "$ref": "#/$defs/TimeLagV2" } ], + "default": null, "description": "Please indicate the typical time-lag between an event and the data for that event appearing in the dataset.", "guidance": "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.", "title": "Time lag" } }, - "required": [ - "publishingFrequency", - "startDate", - "timeLag" - ], "title": "Temporal", "type": "object" }, diff --git a/hdr_schemata/models/HDRUK/v3_0_0/Temporal.py b/hdr_schemata/models/HDRUK/v3_0_0/Temporal.py index 10601f4..60f6c3a 100644 --- a/hdr_schemata/models/HDRUK/v3_0_0/Temporal.py +++ b/hdr_schemata/models/HDRUK/v3_0_0/Temporal.py @@ -14,19 +14,27 @@ class Config: extra = "forbid" publishingFrequency: PeriodicityV2 = Field( - ..., **an.publishingFrequency.__dict__, json_schema_extra={"guidance": an.publishingFrequency.guidance} + None, + **an.publishingFrequency.__dict__, + json_schema_extra={"guidance": an.publishingFrequency.guidance} ) distributionReleaseDate: Optional[Union[date, datetime]] = Field( - None, **an.distributionReleaseDate.__dict__, json_schema_extra={"guidance": an.distributionReleaseDate.guidance} + None, + **an.distributionReleaseDate.__dict__, + json_schema_extra={"guidance": an.distributionReleaseDate.guidance} ) startDate: Union[date, datetime] = Field( - ..., **an.startDate.__dict__, json_schema_extra={"guidance": an.startDate.guidance} + None, + **an.startDate.__dict__, + json_schema_extra={"guidance": an.startDate.guidance} ) - + endDate: Optional[Union[date, datetime, EndDateEnum]] = Field( None, **an.endDate.__dict__, json_schema_extra={"guidance": an.endDate.guidance} ) - timeLag: TimeLagV2 = Field(..., **an.timeLag.__dict__, json_schema_extra={"guidance": an.timeLag.guidance}) + timeLag: TimeLagV2 = Field( + None, **an.timeLag.__dict__, json_schema_extra={"guidance": an.timeLag.guidance} + ) From 61003de126681c56e17ac1ca52e61ea1507a3638 Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Thu, 15 Aug 2024 15:04:08 +0100 Subject: [PATCH 6/7] revert change --- hdr_schemata/definitions/HDRUK/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hdr_schemata/definitions/HDRUK/__init__.py b/hdr_schemata/definitions/HDRUK/__init__.py index 07527d5..03ce7c9 100644 --- a/hdr_schemata/definitions/HDRUK/__init__.py +++ b/hdr_schemata/definitions/HDRUK/__init__.py @@ -20,7 +20,7 @@ from .IsPartOfEnum import IsPartOfEnum from .Isocountrycode import Isocountrycode from .Language import Language -from .Language import LanguageEnum +from .LanguageEnum import LanguageEnum from .LongAbstractText import LongAbstractText from .LongDescription import LongDescription from .MaterialTypeCategories import MaterialTypeCategories, MaterialTypeCategoriesV2 From fac27946c7ec4dbbcc589f2574eaa044f1220a04 Mon Sep 17 00:00:00 2001 From: Calum Macdonald Date: Thu, 15 Aug 2024 15:39:22 +0100 Subject: [PATCH 7/7] fix for some stuff --- docs/HDRUK/2.1.2.md | 144 ++++++++-------- docs/HDRUK/2.1.2.structure.json | 48 +++--- docs/HDRUK/2.1.3.md | 144 ++++++++-------- docs/HDRUK/2.1.3.structure.json | 48 +++--- docs/HDRUK/2.2.0.md | 138 ++++++++-------- docs/HDRUK/2.2.0.structure.json | 46 +++--- docs/HDRUK/2.2.1.md | 114 ++++++------- docs/HDRUK/2.2.1.structure.json | 38 ++--- docs/HDRUK/3.0.0.form.json | 284 +++++++++++++++++++++++++++++--- docs/HDRUK/3.0.0.md | 30 ++-- docs/HDRUK/3.0.0.structure.json | 43 ++--- 11 files changed, 656 insertions(+), 421 deletions(-) diff --git a/docs/HDRUK/2.1.2.md b/docs/HDRUK/2.1.2.md index 9d5bd4a..ec51f07 100644 --- a/docs/HDRUK/2.1.2.md +++ b/docs/HDRUK/2.1.2.md @@ -175,9 +175,9 @@ Please provide a URL that describes the organisation. Organisation contact point(s) -| title | guidance | is_list | required | type | -|:---------------------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------| +| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -210,9 +210,9 @@ Examples: Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users. -| title | guidance | is_list | required | type | -|:---------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -223,9 +223,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'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -267,9 +267,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Associated Media | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -280,9 +280,9 @@ Examples: Please complete only if the dataset is part of a group or family -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -302,9 +302,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Geographic Coverage | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -328,9 +328,9 @@ Examples: Availability of physical samples associated with the dataset. If samples are available, please indicate the types of samples that are available. More than one type may be provided. If sample are not yet available, please provide “AVAILABILITY TO BE CONFIRMED”. If samples are not available, then please provide “NOT AVAILABLE”. -| title | guidance | is_list | required | type | -|:-----------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------| -| Physical Sample Availability | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Physical Sample Availability | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -381,9 +381,9 @@ Coverate by origin (geographical and situations) Please indicate the purpose(s) that the dataset was collected. -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Purpose | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Purpose | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -392,9 +392,9 @@ Please indicate the purpose(s) that the dataset was collected. Please indicate the source of the data extraction -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Source | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Source.Source]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Source | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -403,9 +403,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 Situation Setting | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Collection Situation Setting | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -496,9 +496,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Limitation | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -507,9 +507,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Requirements | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -518,9 +518,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' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Citation Requirements' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -529,9 +529,9 @@ Please provide the text that you would like included as part of any citation tha None -| title | guidance | is_list | required | type | -|:---------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -540,9 +540,9 @@ None Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list. -| title | guidance | is_list | required | type | -|:----------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------| +| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'List', 'null'] | @@ -584,9 +584,9 @@ Examples: Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian. -| title | guidance | is_list | required | type | -|:---------------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -606,9 +606,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +| title | guidance | is_list | required | type | +|:-------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Jurisdiction | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -648,9 +648,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Controlled Vocabulary | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -659,9 +659,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 | -|:------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Conforms To | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Conforms To | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -672,9 +672,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Language | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -683,9 +683,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Format | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -703,9 +703,9 @@ This section includes information about related datasets that may have previousl If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted. -| title | guidance | is_list | required | type | -|:----------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -714,9 +714,9 @@ If applicable, please provide the DOI of other datasets that have previously bee Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset. -| title | guidance | is_list | required | type | -|:------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -725,9 +725,9 @@ Indicate if derived datasets or predefined extracts are available and the type o Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/ -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | diff --git a/docs/HDRUK/2.1.2.structure.json b/docs/HDRUK/2.1.2.structure.json index ae5863b..c46c6b1 100644 --- a/docs/HDRUK/2.1.2.structure.json +++ b/docs/HDRUK/2.1.2.structure.json @@ -235,7 +235,7 @@ "examples": null, "type": [ "EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]", + "List", "null" ], "is_list": false, @@ -286,7 +286,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]", + "List", "null" ], "is_list": false, @@ -302,7 +302,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -368,7 +368,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -386,7 +386,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]", + "List", "null" ], "is_list": false, @@ -420,7 +420,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -455,7 +455,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List", + "List", "null" ], "is_list": false, @@ -530,7 +530,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]", + "List", "null" ], "is_list": false, @@ -546,7 +546,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Source.Source]", + "List", "null" ], "is_list": false, @@ -562,7 +562,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]", + "List", "null" ], "is_list": false, @@ -697,7 +697,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]", + "List", "null" ], "is_list": false, @@ -713,7 +713,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]", + "List", "null" ], "is_list": false, @@ -729,7 +729,7 @@ "examples": null, "type": [ "ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -745,7 +745,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -762,7 +762,7 @@ "type": [ "Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", "str", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]", + "List", "null" ], "is_list": false, @@ -825,7 +825,7 @@ "examples": null, "type": [ "LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -855,7 +855,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]", + "List", "null" ], "is_list": false, @@ -917,7 +917,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]", + "List", "null" ], "is_list": false, @@ -935,7 +935,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]", + "List", "null" ], "is_list": false, @@ -951,7 +951,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Language.Language]", + "List", "null" ], "is_list": false, @@ -967,7 +967,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Format.Format]", + "List", "null" ], "is_list": false, @@ -1001,7 +1001,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]", + "List", "null" ], "is_list": false, @@ -1017,7 +1017,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]", + "List", "null" ], "is_list": false, @@ -1033,7 +1033,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, diff --git a/docs/HDRUK/2.1.3.md b/docs/HDRUK/2.1.3.md index 45201c3..d40f8bd 100644 --- a/docs/HDRUK/2.1.3.md +++ b/docs/HDRUK/2.1.3.md @@ -175,9 +175,9 @@ Please provide a URL that describes the organisation. Organisation contact point(s) -| title | guidance | is_list | required | type | -|:---------------------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------| +| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -210,9 +210,9 @@ Examples: Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users. -| title | guidance | is_list | required | type | -|:---------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -223,9 +223,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'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -267,9 +267,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Associated Media | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -280,9 +280,9 @@ Examples: Please complete only if the dataset is part of a group or family -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -302,9 +302,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Geographic Coverage | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -328,9 +328,9 @@ Examples: Availability of physical samples associated with the dataset. If samples are available, please indicate the types of samples that are available. More than one type may be provided. If sample are not yet available, please provide “AVAILABILITY TO BE CONFIRMED”. If samples are not available, then please provide “NOT AVAILABLE”. -| title | guidance | is_list | required | type | -|:-----------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------| -| Physical Sample Availability | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Physical Sample Availability | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -381,9 +381,9 @@ Coverate by origin (geographical and situations) Please indicate the purpose(s) that the dataset was collected. -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Purpose | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Purpose | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -392,9 +392,9 @@ Please indicate the purpose(s) that the dataset was collected. Please indicate the source of the data extraction -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Source | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Source.Source]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Source | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -403,9 +403,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 Situation Setting | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Collection Situation Setting | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -496,9 +496,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Limitation | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -507,9 +507,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Requirements | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -518,9 +518,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' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Citation Requirements' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -529,9 +529,9 @@ Please provide the text that you would like included as part of any citation tha None -| title | guidance | is_list | required | type | -|:---------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -540,9 +540,9 @@ None Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list. -| title | guidance | is_list | required | type | -|:----------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------| +| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'List', 'null'] | @@ -584,9 +584,9 @@ Examples: Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian. -| title | guidance | is_list | required | type | -|:---------------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -606,9 +606,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +| title | guidance | is_list | required | type | +|:-------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Jurisdiction | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -648,9 +648,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Controlled Vocabulary | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -659,9 +659,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 | -|:------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Conforms To | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Conforms To | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -672,9 +672,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Language | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -683,9 +683,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Format | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -703,9 +703,9 @@ This section includes information about related datasets that may have previousl If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted. -| title | guidance | is_list | required | type | -|:----------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -714,9 +714,9 @@ If applicable, please provide the DOI of other datasets that have previously bee Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset. -| title | guidance | is_list | required | type | -|:------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -725,9 +725,9 @@ Indicate if derived datasets or predefined extracts are available and the type o Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/ -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | diff --git a/docs/HDRUK/2.1.3.structure.json b/docs/HDRUK/2.1.3.structure.json index 8fbbb46..3fe2edb 100644 --- a/docs/HDRUK/2.1.3.structure.json +++ b/docs/HDRUK/2.1.3.structure.json @@ -235,7 +235,7 @@ "examples": null, "type": [ "EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]", + "List", "null" ], "is_list": false, @@ -286,7 +286,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]", + "List", "null" ], "is_list": false, @@ -302,7 +302,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -368,7 +368,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -386,7 +386,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]", + "List", "null" ], "is_list": false, @@ -420,7 +420,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -455,7 +455,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List", + "List", "null" ], "is_list": false, @@ -530,7 +530,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]", + "List", "null" ], "is_list": false, @@ -546,7 +546,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Source.Source]", + "List", "null" ], "is_list": false, @@ -562,7 +562,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]", + "List", "null" ], "is_list": false, @@ -697,7 +697,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]", + "List", "null" ], "is_list": false, @@ -713,7 +713,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]", + "List", "null" ], "is_list": false, @@ -729,7 +729,7 @@ "examples": null, "type": [ "ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -745,7 +745,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -762,7 +762,7 @@ "type": [ "Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", "str", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]", + "List", "null" ], "is_list": false, @@ -825,7 +825,7 @@ "examples": null, "type": [ "LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -855,7 +855,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]", + "List", "null" ], "is_list": false, @@ -917,7 +917,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]", + "List", "null" ], "is_list": false, @@ -935,7 +935,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]", + "List", "null" ], "is_list": false, @@ -951,7 +951,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Language.Language]", + "List", "null" ], "is_list": false, @@ -967,7 +967,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Format.Format]", + "List", "null" ], "is_list": false, @@ -1001,7 +1001,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]", + "List", "null" ], "is_list": false, @@ -1017,7 +1017,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]", + "List", "null" ], "is_list": false, @@ -1033,7 +1033,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, diff --git a/docs/HDRUK/2.2.0.md b/docs/HDRUK/2.2.0.md index 8ad0ce6..19921c2 100644 --- a/docs/HDRUK/2.2.0.md +++ b/docs/HDRUK/2.2.0.md @@ -175,9 +175,9 @@ Please provide a URL that describes the organisation. Organisation contact point(s) -| title | guidance | is_list | required | type | -|:---------------------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------| +| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -210,9 +210,9 @@ Examples: Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users. -| title | guidance | is_list | required | type | -|:---------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -223,9 +223,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'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -300,9 +300,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Associated Media | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -313,9 +313,9 @@ Examples: Please complete only if the dataset is part of a group or family -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -335,9 +335,9 @@ Observational, Spatial and Temporal coverage The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race. -| title | guidance | is_list | required | type | -|:--------------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Geographic Coverage | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Geographic Coverage | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -478,9 +478,9 @@ Coverate by origin (geographical and situations) Please indicate the purpose(s) that the dataset was collected. -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Purpose | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Purpose | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -489,9 +489,9 @@ Please indicate the purpose(s) that the dataset was collected. Please indicate the source of the data extraction -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Source | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Source.Source]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Source | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -500,9 +500,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 Situation Setting | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Collection Situation Setting | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -593,9 +593,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Limitation | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -604,9 +604,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Requirements | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -615,9 +615,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' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Citation Requirements' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -626,9 +626,9 @@ Please provide the text that you would like included as part of any citation tha None -| title | guidance | is_list | required | type | -|:---------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -637,9 +637,9 @@ None Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list. -| title | guidance | is_list | required | type | -|:----------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------| +| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'List', 'null'] | @@ -681,9 +681,9 @@ Examples: Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian. -| title | guidance | is_list | required | type | -|:---------------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -703,9 +703,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +| title | guidance | is_list | required | type | +|:-------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Jurisdiction | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -745,9 +745,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Controlled Vocabulary | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -756,9 +756,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 | -|:------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Conforms To | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Conforms To | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -769,9 +769,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Language | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -780,9 +780,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Format | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -800,9 +800,9 @@ This section includes information about related datasets that may have previousl If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted. -| title | guidance | is_list | required | type | -|:----------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -811,9 +811,9 @@ If applicable, please provide the DOI of other datasets that have previously bee Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset. -| title | guidance | is_list | required | type | -|:------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -822,9 +822,9 @@ Indicate if derived datasets or predefined extracts are available and the type o Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/ -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | diff --git a/docs/HDRUK/2.2.0.structure.json b/docs/HDRUK/2.2.0.structure.json index d30083a..33aeac4 100644 --- a/docs/HDRUK/2.2.0.structure.json +++ b/docs/HDRUK/2.2.0.structure.json @@ -235,7 +235,7 @@ "examples": null, "type": [ "EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]", + "List", "null" ], "is_list": false, @@ -286,7 +286,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]", + "List", "null" ], "is_list": false, @@ -302,7 +302,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -412,7 +412,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -430,7 +430,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]", + "List", "null" ], "is_list": false, @@ -464,7 +464,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -647,7 +647,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Purpose.Purpose]", + "List", "null" ], "is_list": false, @@ -663,7 +663,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Source.Source]", + "List", "null" ], "is_list": false, @@ -679,7 +679,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Setting.Setting]", + "List", "null" ], "is_list": false, @@ -814,7 +814,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]", + "List", "null" ], "is_list": false, @@ -830,7 +830,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]", + "List", "null" ], "is_list": false, @@ -846,7 +846,7 @@ "examples": null, "type": [ "ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -862,7 +862,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -879,7 +879,7 @@ "type": [ "Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", "str", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]", + "List", "null" ], "is_list": false, @@ -942,7 +942,7 @@ "examples": null, "type": [ "LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -972,7 +972,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]", + "List", "null" ], "is_list": false, @@ -1034,7 +1034,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]", + "List", "null" ], "is_list": false, @@ -1052,7 +1052,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.StandardisedDataModels.StandardisedDataModels]", + "List", "null" ], "is_list": false, @@ -1068,7 +1068,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Language.Language]", + "List", "null" ], "is_list": false, @@ -1084,7 +1084,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Format.Format]", + "List", "null" ], "is_list": false, @@ -1118,7 +1118,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]", + "List", "null" ], "is_list": false, @@ -1134,7 +1134,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]", + "List", "null" ], "is_list": false, @@ -1150,7 +1150,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, diff --git a/docs/HDRUK/2.2.1.md b/docs/HDRUK/2.2.1.md index db32e58..1e112dd 100644 --- a/docs/HDRUK/2.2.1.md +++ b/docs/HDRUK/2.2.1.md @@ -175,9 +175,9 @@ Please provide a URL that describes the organisation. Organisation contact point(s) -| title | guidance | is_list | required | type | -|:---------------------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------| +| Organisation Contact Point | | False | True | ["EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -210,9 +210,9 @@ Examples: Please provide a list of relevant and specific keywords that can improve the SEO of your dataset as a comma separated list. Notes: Onboarding portal will suggest keywords based on title, abstract and description. We are compiling a standardised list of keywords and synonyms across datasets to make filtering easier for users. -| title | guidance | is_list | required | type | -|:---------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Keywords | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -223,9 +223,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'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Alternate dataset identifiers | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -300,9 +300,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Associated Media | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -313,9 +313,9 @@ Examples: Please complete only if the dataset is part of a group or family -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Group | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -335,9 +335,9 @@ Observational, Spatial and Temporal coverage The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race. -| title | guidance | is_list | required | type | -|:--------------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Geographic Coverage | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Geographic Coverage | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | Examples: @@ -593,9 +593,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]', 'null'] | +| title | guidance | is_list | required | type | +|:--------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Limitation | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -604,9 +604,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 | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Data Use Requirements | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -615,9 +615,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' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]', 'null'] | +| title | guidance | is_list | required | type | +|:-----------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Citation Requirements' | | False | False | ["ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -626,9 +626,9 @@ Please provide the text that you would like included as part of any citation tha None -| title | guidance | is_list | required | type | -|:---------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Investigations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -637,9 +637,9 @@ None Please provide the keystone paper associated with the dataset. Also include a list of known citations, if available and should be links to existing resources where the dataset has been used or referenced. Please provide multiple entries, or if you are using a csv upload please provide them as a tab separated list. -| title | guidance | is_list | required | type | -|:----------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------| +| Citations | | False | False | ["Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", 'str', 'List', 'null'] | @@ -681,9 +681,9 @@ Examples: Please provide link(s) to a webpage detailing the commercial model for processing data access requests for the organisation (if available) Definition: Indication of commercial model or cost (in GBP) for processing each data access request by the data custodian. -| title | guidance | is_list | required | type | -|:---------------------------------|:-----------|:----------|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:---------------------------------|:-----------|:----------|:-----------|:---------------------------------------------------------------------------------------------------------------------------| +| Organisation Access Request Cost | | False | False | ["LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -703,9 +703,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]', 'null'] | +| title | guidance | is_list | required | type | +|:-------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Jurisdiction | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -758,9 +758,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Controlled Vocabulary | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -782,9 +782,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Language.Language]', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Language | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -793,9 +793,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 | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[hdr_schemata.definitions.HDRUK.Format.Format]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Format | | False | True | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -813,9 +813,9 @@ This section includes information about related datasets that may have previousl If applicable, please provide the DOI of other datasets that have previously been linked to this dataset and their availability. If no DOI is available, please provide the title of the datasets that can be linked, where possible using the same title of a dataset previously onboarded to the HOP. Note: If all the datasets from Gateway organisation can be linked please indicate “ALL” and the onboarding portal will automate linkage across the datasets submitted. -| title | guidance | is_list | required | type | -|:----------------|:-----------|:----------|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]', 'null'] | +| title | guidance | is_list | required | type | +|:----------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Linked Datasets | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -824,9 +824,9 @@ If applicable, please provide the DOI of other datasets that have previously bee Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset. -| title | guidance | is_list | required | type | -|:------------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]', 'null'] | +| title | guidance | is_list | required | type | +|:------------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Derivations | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | @@ -835,9 +835,9 @@ Indicate if derived datasets or predefined extracts are available and the type o Please provide the URL of any analysis tools or models that have been created for this dataset and are available for further use. Multiple tools may be provided. Note: We encourage users to adopt a model along the lines of https://www.ga4gh.org/news/tool-registry-service-api-enabling-an-interoperable-library-of-genomics-analysis-tools/ -| title | guidance | is_list | required | type | -|:--------|:-----------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]', 'null'] | +| title | guidance | is_list | required | type | +|:--------|:-----------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| +| Tools | | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'List', 'null'] | diff --git a/docs/HDRUK/2.2.1.structure.json b/docs/HDRUK/2.2.1.structure.json index 96a5c54..3521d25 100644 --- a/docs/HDRUK/2.2.1.structure.json +++ b/docs/HDRUK/2.2.1.structure.json @@ -235,7 +235,7 @@ "examples": null, "type": [ "EmailAddress[{'anyOf': [{'format': 'email', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.EmailAddress.EmailAddress]]", + "List", "null" ], "is_list": false, @@ -286,7 +286,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]", + "List", "null" ], "is_list": false, @@ -302,7 +302,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -412,7 +412,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -430,7 +430,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters, hdr_schemata.definitions.HDRUK.IsPartOfEnum.IsPartOfEnum]]", + "List", "null" ], "is_list": false, @@ -464,7 +464,7 @@ ], "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -805,7 +805,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseLimitation.DataUseLimitation]", + "List", "null" ], "is_list": false, @@ -821,7 +821,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.DataUseRequirements.DataUseRequirements]", + "List", "null" ], "is_list": false, @@ -837,7 +837,7 @@ "examples": null, "type": [ "ShortDescription[{'anyOf': [{'maxLength': 1000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.ShortDescription.ShortDescription]]", + "List", "null" ], "is_list": false, @@ -853,7 +853,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -870,7 +870,7 @@ "type": [ "Doi[{'anyOf': [{'pattern': '^10.\\\\d{4,9}/[-._;()/:a-zA-Z0-9]+$', 'type': 'string'}, {'type': 'null'}]}]", "str", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Doi.Doi]]", + "List", "null" ], "is_list": false, @@ -933,7 +933,7 @@ "examples": null, "type": [ "LongDescription[{'anyOf': [{'maxLength': 50000, 'minLength': 2, 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, @@ -963,7 +963,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Isocountrycode.Isocountrycode]", + "List", "null" ], "is_list": false, @@ -1040,7 +1040,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.ControlledVocabulary.ControlledVocabulary]", + "List", "null" ], "is_list": false, @@ -1072,7 +1072,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Language.Language]", + "List", "null" ], "is_list": false, @@ -1088,7 +1088,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[hdr_schemata.definitions.HDRUK.Format.Format]", + "List", "null" ], "is_list": false, @@ -1122,7 +1122,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Union[hdr_schemata.definitions.HDRUK.Url.Url, NoneType, hdr_schemata.definitions.HDRUK.OneHundredFiftyCharacters.OneHundredFiftyCharacters]]", + "List", "null" ], "is_list": false, @@ -1138,7 +1138,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.AbstractText.AbstractText]]", + "List", "null" ], "is_list": false, @@ -1154,7 +1154,7 @@ "examples": null, "type": [ "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "typing.List[typing.Optional[hdr_schemata.definitions.HDRUK.Url.Url]]", + "List", "null" ], "is_list": false, diff --git a/docs/HDRUK/3.0.0.form.json b/docs/HDRUK/3.0.0.form.json index bb005bb..0da9cea 100644 --- a/docs/HDRUK/3.0.0.form.json +++ b/docs/HDRUK/3.0.0.form.json @@ -430,7 +430,7 @@ "guidance": "Indicate the specimen type, can be several values from the list below:\\n- 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 **\u201cAvailability to be confirmed\u201d**.\\n- If samples are not available, then please provide **\u201cNot available\u201d**.\\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.", "examples": null, "is_list": true, - "is_optional": false, + "is_optional": true, "types": { "type": "string", "options": [ @@ -730,7 +730,7 @@ "location": "provenance.origin.imageContrast" }, { - "required": true, + "required": false, "title": "Publishing frequency", "description": "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 \u201con-demand\u201d 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/", "guidance": "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 \u201con-demand\u201d 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 https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/.\\n\\n Options:\\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.", @@ -771,7 +771,7 @@ "location": "provenance.temporal.distributionReleaseDate" }, { - "required": true, + "required": false, "title": "Start date", "description": "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.", "guidance": "- 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.", @@ -793,7 +793,7 @@ "location": "provenance.temporal.endDate" }, { - "required": true, + "required": false, "title": "Time lag", "description": "Please indicate the typical time-lag between an event and the data for that event appearing in the dataset.", "guidance": "Please indicate the typical time-lag between an event and the data for that event appearing in the dataset.\\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.", @@ -1047,7 +1047,7 @@ "location": "accessibility.access.dataProcessor" }, { - "required": true, + "required": false, "title": "Controlled vocabulary", "description": "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 \u201cother\u201d and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.", "guidance": "- 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 \u201cother\u201d 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**: ", @@ -1055,13 +1055,52 @@ "is_list": true, "is_optional": false, "types": { - "title": "ControlledVocabulary", - "$ref": "#/$defs/ControlledVocabularyEnum" + "type": "string", + "options": [ + "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" + ] }, "location": "accessibility.formatAndStandards.vocabularyEncodingScheme" }, { - "required": true, + "required": false, "title": "Alignment with standardised data models", "description": "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 \u201cother\u201d and contact support desk to ask for an addition.", "guidance": "- 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 \u201cother\u201d 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**: .", @@ -1071,28 +1110,231 @@ "is_list": true, "is_optional": false, "types": { - "title": "StandardisedDataModels", - "$ref": "#/$defs/StandardisedDataModelsEnum" + "type": "string", + "options": [ + "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" + ] }, "location": "accessibility.formatAndStandards.conformsTo" }, { - "required": true, + "required": false, "title": "Language", "description": "This should list all the languages in which the dataset metadata and underlying data is made available complaint with ISO 639.", "guidance": "https://www.iso.org/iso-639-language-code\\n- **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\u00e5l, Norwegian; Norwegian Bokm\u00e5l\\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\u00fck\\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", "examples": null, - "is_list": false, - "is_optional": true, + "is_list": true, + "is_optional": false, "types": { - "title": "CommaSeparatedValues", - "pattern": "([^,]+)", - "type": "string" + "type": "string", + "options": [ + "aa", + "ab", + "ae", + "af", + "ak", + "am", + "an", + "ar", + "as", + "av", + "ay", + "az", + "ba", + "be", + "bg", + "bh", + "bi", + "bm", + "bn", + "bo", + "br", + "bs", + "ca", + "ce", + "ch", + "co", + "cr", + "cs", + "cu", + "cv", + "cy", + "da", + "de", + "dv", + "dz", + "ee", + "el", + "en", + "eo", + "es", + "et", + "eu", + "fa", + "ff", + "fi", + "fj", + "fo", + "fr", + "fy", + "ga", + "gd", + "gl", + "gn", + "gu", + "gv", + "ha", + "he", + "hi", + "ho", + "hr", + "ht", + "hu", + "hy", + "hz", + "ia", + "id", + "ie", + "ig", + "ii", + "ik", + "io", + "is", + "it", + "iu", + "ja", + "jv", + "ka", + "kg", + "ki", + "kj", + "kk", + "kl", + "km", + "kn", + "ko", + "kr", + "ks", + "ku", + "kv", + "kw", + "ky", + "la", + "lb", + "lg", + "li", + "ln", + "lo", + "lt", + "lu", + "lv", + "mg", + "mh", + "mi", + "mk", + "ml", + "mn", + "mr", + "ms", + "mt", + "my", + "na", + "nb", + "nd", + "ne", + "ng", + "nl", + "nn", + "no", + "nr", + "nv", + "ny", + "oc", + "oj", + "om", + "or", + "os", + "pa", + "pi", + "pl", + "ps", + "pt", + "qu", + "rm", + "rn", + "ro", + "ru", + "rw", + "sa", + "sc", + "sd", + "se", + "sg", + "si", + "sk", + "sl", + "sm", + "sn", + "so", + "sq", + "sr", + "ss", + "st", + "su", + "sv", + "sw", + "ta", + "te", + "tg", + "th", + "ti", + "tk", + "tl", + "tn", + "to", + "tr", + "ts", + "tt", + "tw", + "ty", + "ug", + "uk", + "ur", + "uz", + "ve", + "vi", + "vo", + "wa", + "wo", + "xh", + "yi", + "yo", + "za", + "zh", + "zu" + ] }, "location": "accessibility.formatAndStandards.language" }, { - "required": true, + "required": false, "title": "Format", "description": "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.", "guidance": "- 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- **Example**: text/tab-separated-values, application/sql, text/csv, image/diacom-rle", @@ -1102,11 +1344,11 @@ "text/csv", "image/diacom-rle" ], - "is_list": false, - "is_optional": true, + "is_list": true, + "is_optional": false, "types": { - "title": "CommaSeparatedValues", - "pattern": "([^,]+)", + "minLength": 1, + "title": "Format", "type": "string" }, "location": "accessibility.formatAndStandards.format" diff --git a/docs/HDRUK/3.0.0.md b/docs/HDRUK/3.0.0.md index 52d9701..72049c7 100644 --- a/docs/HDRUK/3.0.0.md +++ b/docs/HDRUK/3.0.0.md @@ -508,7 +508,7 @@ Please indicate the frequency of distribution release. If a dataset is distribut | 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 https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/.

Options:
- **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]"] | +| 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 https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/.

Options:
- **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 | False | ["PeriodicityV2['Static','Irregular','Continuous','Biennial','Annual','Biannual','Quarterly','Bimonthly','Monthly','Biweekly','Weekly','Twice a week','Daily','Other',null]"] | @@ -530,7 +530,7 @@ The start of the time period that the dataset provides coverage for. If there ar | 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'] | +| 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 | False | ['date', 'datetime'] | @@ -552,7 +552,7 @@ Please indicate the typical time-lag between an event and the data for that even | 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']"] | +| 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 | False | ["TimeLagV2['Less than 1 week','1-2 weeks','2-4 weeks','1-2 months','2-6 months','6 months plus','Variable','Not applicable','Other']"] | @@ -740,9 +740,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.
- 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}]"] | +| 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 | False | ["ControlledVocabularyEnum['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']"] | @@ -751,9 +751,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.
- 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}]"] | +| 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 | False | ["StandardisedDataModelsEnum['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']"] | Examples: @@ -764,9 +764,9 @@ Examples: This should list all the languages in which the dataset metadata and underlying data is made available complaint with ISO 639. -| title | guidance | is_list | required | type | -|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:------------------------------------------------------------------------------------------------------------------| -| Language | https://www.iso.org/iso-639-language-code
- **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'}]}]", 'List', 'null'] | +| title | guidance | is_list | required | type | +|:---------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Language | https://www.iso.org/iso-639-language-code
- **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 | True | False | ["LanguageEnum['aa','ab','ae','af','ak','am','an','ar','as','av','ay','az','ba','be','bg','bh','bi','bm','bn','bo','br','bs','ca','ce','ch','co','cr','cs','cu','cv','cy','da','de','dv','dz','ee','el','en','eo','es','et','eu','fa','ff','fi','fj','fo','fr','fy','ga','gd','gl','gn','gu','gv','ha','he','hi','ho','hr','ht','hu','hy','hz','ia','id','ie','ig','ii','ik','io','is','it','iu','ja','jv','ka','kg','ki','kj','kk','kl','km','kn','ko','kr','ks','ku','kv','kw','ky','la','lb','lg','li','ln','lo','lt','lu','lv','mg','mh','mi','mk','ml','mn','mr','ms','mt','my','na','nb','nd','ne','ng','nl','nn','no','nr','nv','ny','oc','oj','om','or','os','pa','pi','pl','ps','pt','qu','rm','rn','ro','ru','rw','sa','sc','sd','se','sg','si','sk','sl','sm','sn','so','sq','sr','ss','st','su','sv','sw','ta','te','tg','th','ti','tk','tl','tn','to','tr','ts','tt','tw','ty','ug','uk','ur','uz','ve','vi','vo','wa','wo','xh','yi','yo','za','zh','zu']"] | @@ -775,9 +775,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, .
- 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.
- **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.
- **Example**: text/tab-separated-values, application/sql, text/csv, image/diacom-rle | True | False | ["Format[{'minLength': 1, 'type': 'string'}]"] | Examples: diff --git a/docs/HDRUK/3.0.0.structure.json b/docs/HDRUK/3.0.0.structure.json index cf4f9ed..c0b4df8 100644 --- a/docs/HDRUK/3.0.0.structure.json +++ b/docs/HDRUK/3.0.0.structure.json @@ -495,7 +495,7 @@ "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']" ], "is_list": true, - "is_optional": false + "is_optional": true }, { "name": "followup", @@ -666,7 +666,7 @@ "subItems": [ { "name": "publishingFrequency", - "required": true, + "required": false, "title": "Publishing frequency", "description": "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 \u201con-demand\u201d 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/", "guidance": "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 \u201con-demand\u201d 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/. Options:- 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.", @@ -694,7 +694,7 @@ }, { "name": "startDate", - "required": true, + "required": false, "title": "Start date", "description": "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.", "guidance": "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.", @@ -724,7 +724,7 @@ }, { "name": "timeLag", - "required": true, + "required": false, "title": "Time lag", "description": "Please indicate the typical time-lag between an event and the data for that event appearing in the dataset.", "guidance": "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.", @@ -984,21 +984,20 @@ "subItems": [ { "name": "vocabularyEncodingScheme", - "required": true, + "required": false, "title": "Controlled vocabulary", "description": "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 \u201cother\u201d and contact support desk to ask for an addition. Notes: More than one vocabulary may be provided.", "guidance": "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 \u201cother\u201d and contact support desk to ask for an addition.- Notes: More than one vocabulary may be provided.- Local: Local Coding Standard.- OPCS4: https://www.datadictionary.nhs.uk/web_site_content/supporting_information/clinical_coding/opcs_classification_of_interventions_and_procedures.asp.- READ: https://digital.nhs.uk/services/terminology-and-classifications/read-codes.- SNOMED CT: http://www.snomed.org/.- SNOMED RT: https://confluence.ihtsdotools.org/display/DOCGLOSS/SNOMED+RT.- DM+D: https://digital.nhs.uk/data-and-information/information-standards/information-standards-and-data-collections-including-extractions/publications-and-notifications/standards-and-collections/scci0052-dictionary-of-medicines-and-devices-dm-d.- NHS National Codes: https://www.datadictionary.nhs.uk/.- ODS: https://digital.nhs.uk/services/organisation-data-service.- LOINC: https://loinc.org/.- ICD10: https://www.who.int/classifications/icd/icdonlineversions/en/.- ICD10CM: https://www.cdc.gov/nchs/icd/icd10cm.htm.- ICD10PCS: https://ec.europa.eu/eip/ageing/standards/healthcare/e-health/icd-10-pcs_en.- ICD9CM: https://www.cdc.gov/nchs/icd/icd9cm.htm.- ICD9: https://www.cdc.gov/nchs/icd/icd9.htm.- ICDO3: https://www.who.int/classifications/icd/adaptations/oncology/en/.- AMT: https://www.digitalhealth.gov.au/about-the-agency/tenders-and-offers/community-pharmacy-software-industry-partnership-offer/Webinar%20-%20Australian%20Medicines%20Terminology%20(AMT)%20and%20Implementation%20Options%2001032017.pdf.- APC: https://www.acep.org/administration/reimbursement/reimbursement-faqs/apc-ambulatory-payment-classifications-faq/.- ATC: https://www.whocc.no/atc_ddd_index/.- CIEL: https://github.com/OpenConceptLab/ocl_web/wiki/CIEL.- HPO: https://hpo.jax.org/app/.- CPT4: https://www.cms.gov/Regulations-and-Guidance/Legislation/CLIA/Downloads/SubjecttoCLIA.pdf.- DPD: https://health-products.canada.ca/dpd-bdpp/index-eng.jsp.- DRG: http://www.euro.who.int/__data/assets/pdf_file/0004/162265/e96538.pdf.- HEMONC: https://hemonc.org/wiki/Main_Page.- JMDC: https://www.jmdc.co.jp/en/.- KCD7: https://forums.ohdsi.org/t/adding-kcd7-code-korean-icd-10-to-the-omop-vocabulary/7576.- MULTUM: https://www.cerner.com/solutions/drug-database.- NAACCR: https://www.naaccr.org/.- NDC: https://www.fda.gov/drugs/drug-approvals-and-databases/national-drug-code-directory.- NDFRT <:https://www.nlm.nih.gov/research/umls/sourcereleasedocs/current/NDFRT/index.html>.- OXMIS: https://oxrisk.com/oxmis/.- RXNORM: https://www.nlm.nih.gov/research/umls/rxnorm/index.html.- RXNORM EXTENSION: https://www.nlm.nih.gov/research/umls/rxnorm/index.html.- SPL: https://www.fda.gov/industry/fda-resources-data-standards/structured-product-labeling-resources.- 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: https://www.ndc.scot.nhs.uk/Data-Dictionary/.- NHS Wales National Codes: http://www.datadictionary.wales.nhs.uk/", "examples": null, "type": [ - "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}]" + "ControlledVocabularyEnum['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']" ], "is_list": true, - "is_optional": false, - "subItems": [] + "is_optional": false }, { "name": "conformsTo", - "required": true, + "required": false, "title": "Alignment with standardised data models", "description": "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 \u201cother\u201d and contact support desk to ask for an addition.", "guidance": "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 \u201cother\u201d and contact support desk to ask for an addition.- HL7 FHIR: https://www.hl7.org/fhir/.- HL7 V2: https://www.hl7.org/implement/standards/product_section.cfm?section=13.- HL7 CDA: https://www.hl7.org/implement/standards/product_section.cfm?section=10.- HL7 CCOW: https://www.hl7.org/implement/standards/product_section.cfm?section=16.- DICOM: https://www.dicomstandard.org/.- I2B2: https://www.i2b2.org/.- IHE: https://www.ihe.net/resources/profiles/.- OMOP: https://www.ohdsi.org/data-standardization/the-common-data-model/.- openEHR: https://www.openehr.org/.- Sentinel: https://www.sentinelinitiative.org/sentinel/data/distributed-database-common-data-model.- PCORnet: https://pcornet.org/data-driven-common-model/.- CDISC: https://www.cdisc.org/standards/data-exchange/odm.- Local: In-house developed data model.- Other: Other standardised data model.- NHS Data Dictionary: https://www.datadictionary.nhs.uk/.- NHS Scotland Data Dictionary: https://www.ndc.scot.nhs.uk/Data-Dictionary/.- NHS Wales Data Dictionary: https://www.datadictionary.wales.nhs.uk/.", @@ -1006,31 +1005,27 @@ "LOCAL,NHS DATA DICTIONARY" ], "type": [ - "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}]" + "StandardisedDataModelsEnum['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']" ], "is_list": true, - "is_optional": false, - "subItems": [] + "is_optional": false }, { "name": "language", - "required": true, + "required": false, "title": "Language", "description": "This should list all the languages in which the dataset metadata and underlying data is made available complaint with ISO 639.", "guidance": "https://www.iso.org/iso-639-language-code- 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\u00e5l, Norwegian; Norwegian Bokm\u00e5l- 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\u00fck- cy: Welsh- wa: Walloon- wo: Wolof- xh: Xhosa- yi: Yiddish- yo: Yoruba- za: Zhuang; Chuang- zh: Chinese- zu: Zulu", "examples": null, "type": [ - "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "List", - "null" + "LanguageEnum['aa','ab','ae','af','ak','am','an','ar','as','av','ay','az','ba','be','bg','bh','bi','bm','bn','bo','br','bs','ca','ce','ch','co','cr','cs','cu','cv','cy','da','de','dv','dz','ee','el','en','eo','es','et','eu','fa','ff','fi','fj','fo','fr','fy','ga','gd','gl','gn','gu','gv','ha','he','hi','ho','hr','ht','hu','hy','hz','ia','id','ie','ig','ii','ik','io','is','it','iu','ja','jv','ka','kg','ki','kj','kk','kl','km','kn','ko','kr','ks','ku','kv','kw','ky','la','lb','lg','li','ln','lo','lt','lu','lv','mg','mh','mi','mk','ml','mn','mr','ms','mt','my','na','nb','nd','ne','ng','nl','nn','no','nr','nv','ny','oc','oj','om','or','os','pa','pi','pl','ps','pt','qu','rm','rn','ro','ru','rw','sa','sc','sd','se','sg','si','sk','sl','sm','sn','so','sq','sr','ss','st','su','sv','sw','ta','te','tg','th','ti','tk','tl','tn','to','tr','ts','tt','tw','ty','ug','uk','ur','uz','ve','vi','vo','wa','wo','xh','yi','yo','za','zh','zu']" ], - "is_list": false, - "is_optional": true, - "subItems": [] + "is_list": true, + "is_optional": false }, { "name": "format", - "required": true, + "required": false, "title": "Format", "description": "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.", "guidance": "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.- 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.- Example: text/tab-separated-values, application/sql, text/csv, image/diacom-rle", @@ -1041,12 +1036,10 @@ "image/diacom-rle" ], "type": [ - "CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", - "List", - "null" + "Format[{'minLength': 1, 'type': 'string'}]" ], - "is_list": false, - "is_optional": true, + "is_list": true, + "is_optional": false, "subItems": [] } ]