-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHDRUKSchema.json
1777 lines (1777 loc) · 61.3 KB
/
HDRUKSchema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "https://raw.githubusercontent.com/HDRUK/schemata/master/schema/dataset/dataset.schema.json",
"type": "object",
"title": "HDR UK Dataset",
"description": "HDR UK Dataset Schema",
"version": "2.0.0",
"required": [
"identifier",
"version",
"revisions",
"issued",
"modified",
"summary",
"accessibility"
],
"additionalProperties": false,
"properties": {
"identifier": {
"$id": "#/properties/identifier",
"title": "Dataset identifier",
"$comment": "http://purl.org/dc/terms/identifier",
"examples": [
[
"226fb3f1-4471-400a-8c39-2b66d46a39b6"
]
],
"description": "System dataset identifier",
"anyOf": [
{
"$ref": "#/definitions/uuidv4"
},
{
"type": "string",
"format": "uri"
}
]
},
"version": {
"$id": "#/properties/version",
"title": "Dataset Version",
"description": "Dataset metadata version",
"$ref": "#/definitions/semver",
"examples": [
"1.1.0"
]
},
"revisions": {
"$id": "#/properties/revisions",
"title": "Dataset Revisions",
"description": "Revisions of Dataset metadata",
"type": "array",
"items": [
{
"$ref": "#/definitions/revision"
}
]
},
"issued": {
"$id": "#/properties/issued",
"title": "Creation Date",
"$comment": "dcat:issued",
"description": "Dataset Metadata Creation Date",
"type": "string",
"format": "date-time"
},
"modified": {
"$id": "#/properties/modified",
"title": "Modification Date",
"$comment": "dcat:modified",
"description": "Dataset Metadata Creation Date",
"type": "string",
"format": "date-time"
},
"summary": {
"$id": "#/properties/summary",
"title": "Summary",
"description": "Summary metadata must be completed by Data Custodians onboarding metadata into the Innovation Gateway MVP.",
"$ref": "#/definitions/summary"
},
"documentation": {
"$id": "#/properties/documentation",
"title": "Documentation",
"description": "Documentation can include a rich text description of the dataset or links to media such as documents, images, presentations, videos or links to data dictionaries, profiles or dashboards. Organisations are required to confirm that they have permission to distribute any additional media.",
"$ref": "#/definitions/documentation"
},
"coverage": {
"$id": "#/properties/coverage",
"title": "Coverage",
"description": "This information includes attributes for geographical and temporal coverage, cohort details etc. to enable a deeper understanding of the dataset content so that researchers can make decisions about the relevance of the underlying data.",
"$ref": "#/definitions/coverage"
},
"provenance": {
"$id": "#/properties/provenance",
"title": "Provenance",
"description": "Provenance information allows researchers to understand data within the context of its origins and can be an indicator of quality, authenticity and timeliness.",
"$ref": "#/definitions/provenance"
},
"accessibility": {
"$id": "#/properties/accessibility",
"title": "Accessibility",
"description": "Accessibility information allows researchers to understand access, usage, limitations, formats, standards and linkage or interoperability with toolsets.",
"$ref": "#/definitions/accessibility"
},
"enrichmentAndLinkage": {
"$id": "#/properties/enrichmentAndLinkage",
"title": "Enrichment and Linkage",
"description": "This section includes information about related datasets that may have previously been linked, as well as indicating if there is the opportunity to link to other datasets in the future. If a dataset has been enriched and/or derivations, scores and existing tools are available this section allows providers to indicate this to researchers.",
"$ref": "#/definitions/enrichmentAndLinkage"
},
"observations": {
"$id": "#/properties/observations",
"title": "Observations",
"$comment": "https://schema.org/observation",
"description": "Multiple observations about the dataset may be provided and users are expected to provide at least one observation (1..*). We will be supporting the schema.org observation model (https://schema.org/Observation) with default values. Users will be encouraged to provide their own statistical populations as the project progresses. Example: <b> Statistical Population 1 </b> type: StatisticalPopulation populationType: Persons numConstraints: 0 <b> Statistical Population 2 </b> type: StatisticalPopulation populationType: Events numConstraints: 0 <b> Statistical Population 3 </b> type: StatisticalPopulation populationType: Findings numConstraints: 0 typeOf: Observation observedNode: <b> Statistical Population 1 </b> measuredProperty: count measuredValue: 32937 observationDate: “2017”",
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/observation"
}
]
}
}
},
"definitions": {
"revision": {
"$id": "#/definitions/revision",
"required": [
"version",
"url"
],
"additionalProperties": false,
"properties": {
"version": {
"$id": "#/definitions/revision/version",
"description": "Semantic Version",
"$ref": "#/definitions/semver"
},
"url": {
"$id": "#/definitions/revision/url",
"description": "URL endpoint to obtain the version",
"$ref": "#/definitions/url"
}
}
},
"summary": {
"$id": "#/definitions/summary",
"required": [
"title",
"abstract",
"publisher",
"contactPoint",
"keywords"
],
"additionalProperties": false,
"properties": {
"title": {
"$id": "#/summary/title",
"$comment": "dct:title. title is reserved word in json schema",
"title": "Title",
"description": "Title of the dataset limited to 80 characters. It should provide a short description of the dataset and be unique across the gateway. If your title is not unique, please add a prefix with your organisation name or identifier to differentiate it from other datasets within the Gateway. Please avoid acronyms wherever possible. Good titles should summarise the content of the dataset and if relevant, the region the dataset covers.",
"examples": [
[
"North West London COVID-19 Patient Level Situation Report"
]
],
"allOf": [
{
"$ref": "#/definitions/eightyCharacters"
}
]
},
"abstract": {
"$id": "#/summary/abstract",
"title": "Dataset Abstract",
"description": "Provide a clear and brief descriptive signpost for researchers who are searching for data that may be relevant to their research. The abstract should allow the reader to determine the scope of the data collection and accurately summarise its content. The optimal length is one paragraph (limited to 255 characters) and effective abstracts should avoid long sentences and abbreviations where possible",
"$comment": "dct:abstract",
"examples": [
"CPRD Aurum contains primary care data contributed by General Practitioner (GP) practices using EMIS Web® including patient registration information and all care events that GPs have chosen to record as part of their usual medical practice."
],
"allOf": [
{
"$ref": "#/definitions/abstractText"
}
]
},
"publisher": {
"$id": "#/summary/publisher",
"$comment": "Conforms to spec, but this MAY be an an object of organisation. https://schema.org/publisher",
"title": "Dataset publisher",
"description": "This is the organisation responsible for running or supporting the data access request process, as well as publishing and maintaining the metadata. In most this will be the same as the HDR UK Organisation (Hub or Alliance Member). However, in some cases this will be different i.e. Tissue Directory are an HDR UK Gateway organisation but coordinate activities across a number of data publishers i.e. Cambridge Blood and Stem Cell Biobank.",
"allOf": [
{
"$ref": "#/definitions/organisation"
}
]
},
"contactPoint": {
"$id": "#/summary/contactPoint",
"title": "Contact Point",
"$comment": "dcat:contactPoint",
"default": "Defaulted to the contact point of the primary organisation of the user however, can be overridden for specific datasets",
"examples": [
],
"description": "Please provide a valid email address that can be used to coordinate data access requests with the publisher. Organisations are expected to provide a dedicated email address associated with the data access request process. Notes: An employee’s email address can only be provided on a temporary basis and if one is provided an explicit consent must be obtained for this purpose.",
"allOf": [
{
"$ref": "#/definitions/emailAddress"
}
]
},
"keywords": {
"$id": "#/summary/keywords",
"$comment": "dcat:keyword. May be an array of strings or comma seperated list.",
"title": "Keywords",
"description": "Please provide 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.",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/eightyCharacters"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
},
"alternateIdentifiers": {
"$id": "#/summary/alternateIdentifiers",
"$comment": "DATA-CITE alternate-identifiers used. Note, will support comma separated list for backwards compatibility with other systems",
"title": "Alternate dataset identifiers",
"description": "Alternate dataset identifiers or local identifiers",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/shortDescription"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
},
"doiName": {
"$id": "#/summary/doiName",
"title": "Digital Object Identifier",
"description": "All HDR UK registered datasets should either have a Digital Object Identifier (DOI) or be working towards obtaining one. If a DOI is available, please provide the DOI.",
"allOf": [
{
"$ref": "#/definitions/doi"
}
],
"$comment": "Vocabulary: DOI Data Dictionary ",
"examples": [
"10.3399/bjgp17X692645"
]
}
}
},
"organisation": {
"$id": "#/definitions/organisation",
"type": "object",
"required": [
"name",
"contactPoint"
],
"title": "Organisation Metadata",
"description": "Describes an organisation for purposes of discovery and identification.",
"properties": {
"identifier": {
"$id": "#/organisation/identifier",
"title": "Organisation Identifier",
"description": "Please provide a Grid.ac identifier (see https://www.grid.ac/institutes) for your organisation. If your organisation does not have a Grid.ac identifier please use the “suggest and institute” function here: https://www.grid.ac/institutes#",
"$comment": "https://schema.org/identifier",
"allOf": [
{
"$ref": "#/definitions/url"
}
]
},
"name": {
"$id": "#/organisation/name",
"title": "Organisation Name",
"description": "Name of the organisation",
"$comment": "https://schema.org/name",
"allOf": [
{
"$ref": "#/definitions/eightyCharacters"
}
]
},
"logo": {
"$id": "#/organisation/logo",
"title": "Organisation Logo",
"description": "Please provide a logo associated with the Gateway Organisation using a valid URL. The following formats will be accepted .jpg, .png or .svg.",
"$comment": "https://schema.org/logo",
"allOf": [
{
"$ref": "#/definitions/url"
}
]
},
"description": {
"$id": "#/organisation/description",
"title": "Organisation Description",
"description": "Please provide a URL that describes the organisation.",
"$comment": "https://schema.org/description",
"allOf": [
{
"$ref": "#/definitions/description"
}
]
},
"contactPoint": {
"$id": "#/organisation/contactPoint",
"title": "Organisation Contact Point",
"description": "Organisation contact point(s)",
"$comment": "https://schema.org/contactPoint",
"anyOf": [
{
"$ref": "#/definitions/emailAddress"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/emailAddress"
}
]
}
}
]
},
"memberOf": {
"$id": "#/organisation/memberOf",
"title": "Organisation Membership",
"description": "Please indicate if the organisation is an Alliance Member or a Hub.",
"$comment": "https://schema.org/memberOf",
"allOf": [
{
"$ref": "#/definitions/memberOf"
}
]
},
"accessRights": {
"$id": "#/organisation/accessRights",
"title": "Organisation Default Access Rights",
"$comment": "dct:access_rights",
"description": "The URL of a webpage where the data access request process and/or guidance is provided. If there is more than one access process i.e. industry vs academic please provide both.",
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
]
},
"deliveryLeadTime": {
"$id": "#/member/deliveryLeadTime",
"title": "Access Request Duration",
"$comment": "https://schema.org/deliveryLeadTime",
"description": "Please provide an indication of the typical processing times based on the types of requests typically received. Note: This value will be used as default access request duration for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.",
"allOf": [
{
"$ref": "#/definitions/deliveryLeadTime"
}
]
},
"accessService": {
"$id": "#/member/accessService",
"title": "Organisation Access Service",
"$comment": "dcat:accessService",
"examples": [
"https://cnfl.extge.co.uk/display/GERE/Research+Environment+User+Guide"
],
"description": "Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.",
"allOf": [
{
"$ref": "#/definitions/longDescription"
}
]
},
"accessRequestCost": {
"$id": "#/member/accessRequestCost",
"title": "Organisation Access Request Cost",
"$comment": "No standard identified",
"description": "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.",
"allOf": [
{
"$ref": "#/definitions/longDescription"
}
]
},
"dataUseLimitation": {
"$id": "#/member/dataUseLimitation",
"title": "Data Use Limitation",
"$comment": "https://www.ebi.ac.uk/ols/ontologies/duo/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000001",
"description": "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. Notes: where there are existing data-sharing arrangements such as the HDR UK HUB data sharing agreement or the NIHR HIC data sharing agreement this should be indicated within access rights. This value will be used as terms for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/dataUseLimitation"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
},
"dataUseRequirements": {
"$id": "#/member/dataUseRequirements",
"title": "Data Use Requirements",
"description": "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.",
"$comment": "https://www.ebi.ac.uk/ols/ontologies/duo/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000001",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/dataUseRequirements"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
}
}
},
"documentation": {
"$id": "#/definitions/member",
"additionalProperties": false,
"properties": {
"description": {
"$id": "#/properties/documentation/description",
"title": "Description",
"$comment": "dc:description, https://schema.org/description",
"description": "A free-text description of the record.",
"allOf": [
{
"$ref": "#/definitions/description"
}
]
},
"associatedMedia": {
"$id": "#/properties/documentation/associatedMedia",
"title": "Associated Media",
"$comment": "https://schema.org/associatedMedia",
"examples": [
"PDF Document that describes study protocol"
],
"description": "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.",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/url"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
},
"isPartOf": {
"$id": "#/properties/documentation/isPartOf",
"title": "Group",
"$comment": "https://schema.org/isPartOf NOTE: we may make Groups first class citizens so the are navigable",
"default": "NOT APPLICABLE",
"examples": [
"Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS)."
],
"description": "Please complete only if the dataset is part of a group or family",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/definitions/url"
},
{
"$ref": "#/definitions/eightyCharacters"
},
{
"type": "string",
"enum": [
"NOT APPLICABLE"
]
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
}
}
},
"coverage": {
"$id": "#/definitions/coverage",
"additionalProperties": false,
"properties": {
"spatial": {
"$id": "#/properties/coverage/spatial",
"title": "Geographic Coverage",
"$comment": "dct:spatial",
"description": "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.",
"examples": [
"https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html"
],
"allOf": [
{
"$ref": "#/definitions/url"
}
]
},
"typicalAgeRange": {
"$id": "#/properties/coverage/typicalAgeRange",
"title": "Age Range",
"$comment": "https://schema.org/typicalAgeRange",
"description": "Please indicate the age range in whole years of participants in the dataset. Please provide range in the following format ‘[min age] – [max age]’ where both the minimum and maximum are whole numbers (integers).",
"allOf": [
{
"$ref": "#/definitions/ageRange"
}
]
},
"physicalSampleAvailability": {
"$id": "#/properties/coverage/physicalSampleAvailability",
"title": "Physical Sample Availability",
"$comment": "No standard identified. Used enumeration from the UK Tissue Directory.",
"examples": [
"BONE MARROW"
],
"description": "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”.",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"contains": {
"$ref": "#/definitions/physicalSampleAvailability"
},
"uniqueItems": true,
"minItems": 1
}
]
},
"followup": {
"$id": "#/properties/coverage/followup",
"title": "Followup",
"$comment": "No standard identified",
"default": "UNKNOWN",
"description": "If known, what is the typical time span that a patient appears in the dataset (follow up period)",
"allOf": [
{
"$ref": "#/definitions/followup"
}
]
},
"pathway": {
"$id": "#/properties/coverage/pathway",
"title": "Pathway",
"$comment": "No standard identified",
"description": "Please indicate if the dataset is representative of the patient pathway and any limitations the dataset may have with respect to pathway coverage. This could include if the dataset is from a single speciality or area, a single tier of care, linked across two tiers (e.g. primary and secondary care), or an integrated care record covering the whole patient pathway.",
"allOf": [
{
"$ref": "#/definitions/description"
}
]
}
}
},
"provenance": {
"$id": "#/definitions/provenance",
"required": [
"temporal"
],
"additionalProperties": false,
"properties": {
"origin": {
"$id": "#/definitions/provenance/origin",
"allOf": [
{
"$ref": "#/definitions/origin"
}
]
},
"temporal": {
"$id": "#/definitions/provenance/temporal",
"allOf": [
{
"$ref": "#/definitions/temporal"
}
]
}
}
},
"origin": {
"$id": "#/definitions/origin",
"additionalProperties": false,
"properties": {
"purpose": {
"$id": "#/properties/provenance/origin/purpose",
"title": "Purpose",
"$comment": "https://ddialliance.org/Specification/DDI-Lifecycle/3.3/XMLSchema/FieldLevelDocumentation/",
"description": "Pleases indicate the purpose(s) that the dataset was collected.",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": [
{
"$ref": "#/definitions/purpose"
}
],
"uniqueItems": true,
"minItems": 1
}
]
},
"source": {
"$id": "#/properties/provenance/origin/source",
"title": "Source",
"$comment": "https://dublincore.org/specifications/dublin-core/dcmi-terms/#source",
"description": "Pleases indicate the source of the data extraction",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": [
{
"$ref": "#/definitions/source"
}
],
"uniqueItems": true,
"minItems": 1
}
]
},
"collectionSituation": {
"$id": "#/properties/provenance/origin/collectionSituation",
"title": "Setting",
"$comment": "https://ddialliance.org/Specification/DDI-Lifecycle/3.2/XMLSchema/FieldLevelDocumentation/",
"description": "Pleases indicate the setting(s) where data was collected. Multiple settings may be provided",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": [
{
"$ref": "#/definitions/setting"
}
],
"uniqueItems": true,
"minItems": 1
}
]
}
}
},
"temporal": {
"$id": "#/definitions/temporal",
"required": [
"accrualPeriodicity",
"timeLag",
"startDate"
],
"additionalProperties": false,
"properties": {
"accrualPeriodicity": {
"$id": "#/properties/provenance/temporal/accrualPeriodicity",
"title": "Periodicity",
"$comment": "dct:accrualPeriodicity",
"default": "",
"description": "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 indicated when it was released. If a dataset is released on an irregular basis or “on-demand” please indicate that it is Irregular and leave release date as null. If a dataset can be published in real-time or near-real-time please indicate that it is continuous and leave release date as null. Notes: see https://www.dublincore.org/specifications/dublin-core/collection-description/frequency/",
"allOf": [
{
"$ref": "#/definitions/periodicity"
}
]
},
"distributionReleaseDate": {
"$id": "#/properties/provenance/temporal/distributionReleaseDate",
"title": "Release Date",
"$comment": "dcat:distribution_release_date",
"description": "Date of the latest release of the dataset. If this is a regular release i.e. quarterly, or this is a static dataset please complete this alongside Periodicity. If this is Irregular or Continuously released please leave this blank. Notes: Periodicity and release date will be used to determine when the next release is expected. E.g. if the release date is documented as 01/01/2020 and it is now 20/04/2020 and there is a quarterly release schedule, the latest release will be calculated as 01/04/2020.",
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"startDate": {
"$id": "#/properties/provenance/temporal/startDate",
"title": "Start Date",
"$comment": "dcat:startDate",
"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.",
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
}
]
},
"endDate": {
"$id": "#/properties/provenance/temporal/endDate",
"title": "End Date",
"$comment": "dcat:endDate",
"description": "The end of the time period that the dataset provides coverage for. If the dataset is “Continuous” and has no known end date, please leave blank. If there are multiple cohorts in the dataset with varying end dates, please provide the latest date and use the description or the media attribute to provide more information.",
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"enum": [
"NOT APPLICABLE"
]
}
]
},
"timeLag": {
"$id": "#/properties/provenance/temporal/timeLag",
"title": "Time Lag",
"$comment": "No standard identified",
"description": "Please indicate the typical time-lag between an event and the data for that event appearing in the dataset",
"allOf": [
{
"$ref": "#/definitions/timeLag"
}
]
}
}
},
"accessibility": {
"$id": "#/definitions/accessibility",
"required": [
"access"
],
"additionalProperties": false,
"properties": {
"usage": {
"$id": "#/definitions/accessibility/usage",
"title": "Usage",
"description": "This section includes information about how the data can be used and how it is currently being used",
"$ref": "#/definitions/usage"
},
"access": {
"$id": "#/definitions/accessibility/access",
"title": "Access",
"description": "This section includes information about data access",
"$ref": "#/definitions/access"
},
"formatAndStandards": {
"$id": "#/definitions/accessibility/formatAndStandards",
"title": "Format and Standards",
"description": "Section includes technical attributes for language vocabularies, sizes etc. and gives researchers facts about and processing the underlying data in the dataset.",
"$ref": "#/definitions/formatAndStandards"
}
}
},
"usage": {
"$id": "#/definitions/usage",
"additionalProperties": false,
"properties": {
"dataUseLimitation": {
"$id": "#/properties/accessibility/usage/dataUseLimitation",
"title": "Data Use Limitation",
"$comment": "https://www.ebi.ac.uk/ols/ontologies/duo/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000001",
"description": "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",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/dataUseLimitation"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
},
"dataUseRequirements": {
"$id": "#/properties/accessibility/usage/dataUseRequirements",
"title": "Data Use Requirements",
"description": "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.",
"$comment": "https://www.ebi.ac.uk/ols/ontologies/duo/terms?iri=http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FDUO_0000001",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/dataUseRequirements"
}
]
},
"uniqueItems": true,
"minItems": 1
}
]
},
"resourceCreator": {
"$id": "#/properties/accessibility/usage/resourceCreator",
"title": "Citation Requirements",
"$comment": "dct:creator",
"description": "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.",
"allOf": [
{
"$ref": "#/definitions/shortDescription"
}
]
},
"investigations": {
"title": "Investigations",
"$comment": "No standard identified",
"anyOf": [
{
"$ref": "#/definitions/commaSeparatedValues"
},
{
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/definitions/url"
}
]
}
}
]
},
"isReferencedBy": {
"title": "Citations",
"$comment": "dct:isReferencedBy ",
"description": "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. [Author] ([Year]) [Title] . [DOI] . [Source]",
"anyOf": [
{
"$ref": "#/definitions/doi"
},
{
"type": "array",
"items": [
{
"$ref": "#/definitions/doi"
}
]
}
]
}
}
},
"access": {
"$id": "#/definitions/access",
"required": [
"accessRights",
"jurisdiction",
"dataController"
],
"additionalProperties": false,
"properties": {
"accessRights": {
"$id": "#/properties/accessibility/access/accessRights",
"title": "Access Rights",
"$comment": "dct:access_rights NOTE: need to ensure that this is consistent across the organisation info and the dataset info",
"anyOf": [
{
"type": "string",
"pattern": "^In Progress$"
},
{
"type": "string",
"format": "uri"
},
{
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
}
]
},
"accessService": {
"$id": "#/properties/accessibility/access/accessService",
"title": "Access Service",
"$comment": "dcat:accessService ",
"examples": [
"https://cnfl.extge.co.uk/display/GERE/Research+Environment+User+Guide"
],
"description": "Please provide a brief description of the data access services that are available including: environment that is currently available to researchers;additional consultancy and services;any indication of costs associated. If no environment is currently available, please indicate the current plans and timelines when and how data will be made available to researchers Note: This value will be used as default access environment for all datasets submitted by the organisation. However, there will be the opportunity to overwrite this value for each dataset.",
"allOf": [
{
"$ref": "#/definitions/longDescription"
}
]
},
"accessRequestCost": {
"$id": "#/member/accessRequestCost",
"title": "Organisation Access Request Cost",
"$comment": "No standard identified",
"description": "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.",
"allOf": [
{
"$ref": "#/definitions/longDescription"
}
]
},
"deliveryLeadTime": {
"$id": "#/properties/accessibility/access/deliveryLeadTime",
"title": "Access Request Duration",
"$comment": "https://schema.org/deliveryLeadTime",
"description": "Please provide an indication of the typical processing times based on the types of requests typically received.",
"allOf": [
{
"$ref": "#/definitions/deliveryLeadTime"
}
]
},
"jurisdiction": {
"$id": "#/properties/accessibility/access/jurisdiction",
"title": "Jurisdiction",
"default": "GB-ENG",
"$comment": "http://purl.org/dc/terms/Jurisdiction FIXME: Add ISO 3166-2 Subdivision code pattern",