diff --git a/docs/GWDM/2.0.form.json b/docs/GWDM/2.0.form.json index 7b1eb5c..017104b 100644 --- a/docs/GWDM/2.0.form.json +++ b/docs/GWDM/2.0.form.json @@ -924,7 +924,7 @@ "title": "OneHundredFiftyCharacters", "type": "string" }, - "location": "linkage.datasetLinkage.derivedFrom.pid" + "location": "linkage.datasetLinkage.isDerivedFrom.pid" }, { "required": false, @@ -940,7 +940,7 @@ "title": "OneHundredFiftyCharacters", "type": "string" }, - "location": "linkage.datasetLinkage.derivedFrom.title" + "location": "linkage.datasetLinkage.isDerivedFrom.title" }, { "required": false, @@ -956,7 +956,7 @@ "minLength": 1, "type": "string" }, - "location": "linkage.datasetLinkage.derivedFrom.url" + "location": "linkage.datasetLinkage.isDerivedFrom.url" }, { "required": false, @@ -1020,7 +1020,7 @@ "title": "OneHundredFiftyCharacters", "type": "string" }, - "location": "linkage.datasetLinkage.linkableDatasets.pid" + "location": "linkage.datasetLinkage.linkedDatasets.pid" }, { "required": false, @@ -1036,7 +1036,7 @@ "title": "OneHundredFiftyCharacters", "type": "string" }, - "location": "linkage.datasetLinkage.linkableDatasets.title" + "location": "linkage.datasetLinkage.linkedDatasets.title" }, { "required": false, @@ -1052,7 +1052,7 @@ "minLength": 1, "type": "string" }, - "location": "linkage.datasetLinkage.linkableDatasets.url" + "location": "linkage.datasetLinkage.linkedDatasets.url" }, { "required": false, @@ -1068,7 +1068,7 @@ "title": "OneHundredFiftyCharacters", "type": "string" }, - "location": "linkage.datasetLinkage.similarToDatasets.pid" + "location": "linkage.datasetLinkage.isMemberOf.pid" }, { "required": false, @@ -1084,7 +1084,7 @@ "title": "OneHundredFiftyCharacters", "type": "string" }, - "location": "linkage.datasetLinkage.similarToDatasets.title" + "location": "linkage.datasetLinkage.isMemberOf.title" }, { "required": false, @@ -1100,7 +1100,7 @@ "minLength": 1, "type": "string" }, - "location": "linkage.datasetLinkage.similarToDatasets.url" + "location": "linkage.datasetLinkage.isMemberOf.url" }, { "required": false, diff --git a/docs/GWDM/2.0.md b/docs/GWDM/2.0.md index e9e8a8d..2ce9429 100644 --- a/docs/GWDM/2.0.md +++ b/docs/GWDM/2.0.md @@ -821,13 +821,15 @@ Dataset Linkage copied over from -#### derivedFrom +#### isDerivedFrom -If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from. +Indicate if derived datasets or predefined extracts are available and the type of derivation available. Notes. Single or multiple dimensions can be provided as a derived extract alongside the dataset +Examples: + * Data will be minimised as appropriate relative to the data access application ##### pid @@ -865,13 +867,13 @@ None #### isPartOf -This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter “NOT APPLICABLE” **Example**: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS). +If the dataset is part of a group or family Examples: - * Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS) + * UKCRC Tissue Directory and Coordination Centre ##### pid @@ -907,13 +909,15 @@ None -#### linkableDatasets +#### linkedDatasets -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. +Links to other datasets. +Examples: + * Yes. To any SAIL dataset & reference data.,ALL ##### pid @@ -949,9 +953,9 @@ None -#### similarToDatasets +#### isMemberOf -Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc. +Dataset is a member of XXX(?) diff --git a/docs/GWDM/2.0.structure.json b/docs/GWDM/2.0.structure.json index d55213b..27cc779 100644 --- a/docs/GWDM/2.0.structure.json +++ b/docs/GWDM/2.0.structure.json @@ -1121,12 +1121,14 @@ "is_optional": true, "subItems": [ { - "name": "derivedFrom", + "name": "isDerivedFrom", "required": false, - "title": "Derived from", - "description": "If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from.", + "title": "Derivations", + "description": "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", "guidance": "", - "examples": null, + "examples": [ + "Data will be minimised as appropriate relative to the data access application" + ], "type": [ "DatasetDescriptor" ], @@ -1183,11 +1185,11 @@ { "name": "isPartOf", "required": false, - "title": "Is part of", - "description": "This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter \u201cNOT APPLICABLE\u201d Example: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).", + "title": "Is PartOf", + "description": "If the dataset is part of a group or family", "guidance": "", "examples": [ - "Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)" + "UKCRC Tissue Directory and Coordination Centre" ], "type": [ "DatasetDescriptor" @@ -1243,12 +1245,14 @@ ] }, { - "name": "linkableDatasets", + "name": "linkedDatasets", "required": false, - "title": "Linked datasets", - "description": "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.", + "title": "Linked Datasets", + "description": "Links to other datasets.", "guidance": "", - "examples": null, + "examples": [ + "Yes. To any SAIL dataset & reference data.,ALL" + ], "type": [ "DatasetDescriptor" ], @@ -1303,10 +1307,10 @@ ] }, { - "name": "similarToDatasets", + "name": "isMemberOf", "required": false, - "title": "Similar to datasets", - "description": "Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc.", + "title": "Is MemberOf", + "description": "Dataset is a member of XXX(?)", "guidance": "", "examples": null, "type": [ diff --git a/hdr_schemata/models/GWDM/2.0/schema.json b/hdr_schemata/models/GWDM/2.0/schema.json index 602c7b4..f26fc09 100644 --- a/hdr_schemata/models/GWDM/2.0/schema.json +++ b/hdr_schemata/models/GWDM/2.0/schema.json @@ -547,7 +547,7 @@ "DatasetLinkage": { "additionalProperties": false, "properties": { - "derivedFrom": { + "isDerivedFrom": { "anyOf": [ { "items": { @@ -560,8 +560,11 @@ } ], "default": null, - "description": "If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from.", - "title": "Derived from" + "description": "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", + "examples": [ + "Data will be minimised as appropriate relative to the data access application" + ], + "title": "Derivations" }, "isPartOf": { "anyOf": [ @@ -576,13 +579,13 @@ } ], "default": null, - "description": "This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter \u201cNOT APPLICABLE\u201d **Example**: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).", + "description": "If the dataset is part of a group or family", "examples": [ - "Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)" + "UKCRC Tissue Directory and Coordination Centre" ], - "title": "Is part of" + "title": "Is PartOf" }, - "linkableDatasets": { + "linkedDatasets": { "anyOf": [ { "items": { @@ -595,10 +598,13 @@ } ], "default": null, - "description": "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.", - "title": "Linked datasets" + "description": "Links to other datasets.", + "examples": [ + "Yes. To any SAIL dataset & reference data.,ALL" + ], + "title": "Linked Datasets" }, - "similarToDatasets": { + "isMemberOf": { "anyOf": [ { "items": { @@ -611,8 +617,8 @@ } ], "default": null, - "description": "Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc.", - "title": "Similar to datasets" + "description": "Dataset is a member of XXX(?)", + "title": "Is MemberOf" } }, "title": "DatasetLinkage", diff --git a/hdr_schemata/models/GWDM/v2_0/DatasetLinkage.py b/hdr_schemata/models/GWDM/v2_0/DatasetLinkage.py index cedff1e..5975352 100644 --- a/hdr_schemata/models/GWDM/v2_0/DatasetLinkage.py +++ b/hdr_schemata/models/GWDM/v2_0/DatasetLinkage.py @@ -13,18 +13,18 @@ class DatasetLinkage(BaseModel): class Config: extra = "forbid" - derivedFrom: Optional[List[DatasetDescriptor]] = Field( - None, **an.derivedFrom.__dict__ + isDerivedFrom: Optional[List[DatasetDescriptor]] = Field( + None, **an.isDerivedFrom.__dict__ ) isPartOf: Optional[List[DatasetDescriptor]] = Field( None, **an.isPartOf.__dict__ ) - linkableDatasets: Optional[List[DatasetDescriptor]] = Field( - None, **an.linkableDatasets.__dict__ + linkedDatasets: Optional[List[DatasetDescriptor]] = Field( + None, **an.linkedDatasets.__dict__ ) - similarToDatasets: Optional[List[DatasetDescriptor]] = Field( - None, **an.similarToDatasets.__dict__ + isMemberOf: Optional[List[DatasetDescriptor]] = Field( + None, **an.isMemberOf.__dict__ ) diff --git a/hdr_schemata/models/GWDM/v2_0/annotations/config.yaml b/hdr_schemata/models/GWDM/v2_0/annotations/config.yaml index fc33c13..4cd91de 100644 --- a/hdr_schemata/models/GWDM/v2_0/annotations/config.yaml +++ b/hdr_schemata/models/GWDM/v2_0/annotations/config.yaml @@ -386,24 +386,28 @@ linkage: - "https://digital.nhs.uk/services/data-access-request-service-dars/register-of-approved-data-releases" title: "Investigations" - derivedFrom: - title: "Derived from" - description: "If applicable, please provide DOIs or links to datasets from which data in this dataset has been derived or calculated from." - + isDerivedFrom: + description: "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" + examples: + - "Data will be minimised as appropriate relative to the data access application" + title: Derivations + isPartOf: - title: "Is part of" - description: "This relationship indicates that the dataset is a component or subset of a broader collection of related datasets. For example, clinical trial data for a specific drug may be part of a larger database of pharmaceutical research data. Complete only if the dataset is part of a group or family of datasets i.e. Hospital Episode Statistics has several constituents. If your dataset is not part of a group, please enter “NOT APPLICABLE” **Example**: Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)." - examples: - - "Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)" - - similarToDatasets: - title: "Similar to datasets" - description: "Datasets that are similar to each other in some way, collect similar patients, regional equivalent etc." - - linkableDatasets: - title: "Linked datasets" - description: "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." + description: "If the dataset is part of a group or family" + examples: + - "UKCRC Tissue Directory and Coordination Centre" + title: "Is PartOf" + + isMemberOf: + description: "Dataset is a member of XXX(?)" + title: "Is MemberOf" + linkedDatasets: + description: "Links to other datasets." + examples: + - "Yes. To any SAIL dataset & reference data.,ALL" + title: "Linked Datasets" + syntheticDataWebLink: description: Links to locations of information and or raw downloads of synthetic data associated with this dataset title: "Synthetic Data Web Links"