-
Notifications
You must be signed in to change notification settings - Fork 5
/
cohort-schema.json
2190 lines (2190 loc) · 135 KB
/
cohort-schema.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
{
"$comment": "version: ga4gh-beacon-cohort-v2.0.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "A cohort available in the beacon.",
"properties": {
"cohortDataTypes": {
"description": "Type of information. Preferably values from Genomics Cohorts Knowledge Ontology (GeCKO) or others when GeCKO is not applicable.",
"examples": [
{
"id": "OGMS:0000015",
"label": "clinical history"
},
{
"id": "OBI:0000070",
"label": "genotyping assay"
},
{
"id": "OMIABIS:0000060",
"label": "survey data"
}
],
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"type": "array"
},
"cohortDesign": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"cohortSize": {
"description": "Count of unique Individuals in cohort (individuals meeting criteria for \u00b4user-defined\u00b4 cohorts). If not previously known, it could be calculated by counting the individuals in the cohort.",
"examples": [
14765,
20000
],
"type": "integer"
},
"cohortType": {
"default": "beacon-defined",
"description": "Cohort type by its definition. If a cohort is declared \u00b4study-defined\u00b4 or \u00b4beacon-defined\u00b4 criteria are to be entered in cohort_inclusion_criteria; if a cohort is declared \u2018user-defined' cohort_inclusion_criteria could be automatically populated from the parameters used to perform the query.",
"enum": [
"study-defined",
"beacon-defined",
"user-defined"
],
"type": "string"
},
"collectionEvents": {
"description": "TBD",
"items": {
"description": "TBD",
"properties": {
"eventAgeRange": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventCases": {
"description": "count of cases",
"examples": [
543,
20
],
"type": "integer"
},
"eventControls": {
"description": "count of controls",
"examples": [
1000,
22
],
"type": "integer"
},
"eventDataTypes": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventDate": {
"description": "date of collection event/data point",
"examples": [
"2018-10-01T13:23:45Z",
"2019-04-23T09:11:13Z",
"2017-01-17T20:33:40Z"
],
"format": "datetime",
"type": "string"
},
"eventDiseases": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventEthnicities": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventGenders": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventLocations": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventNum": {
"description": "cardinality of the collection event / data point in a series",
"examples": [
1,
2,
3,
4
],
"type": "integer"
},
"eventPhenotypes": {
"description": "Aggregated information of geographic location obtained from individual level info in database.",
"properties": {
"availability": {
"description": "data availability",
"type": "boolean"
},
"availabilityCount": {
"description": "count of individuals with data available",
"type": "integer"
},
"distribution": {
"additionalProperties": {
"type": "object"
},
"description": "List of categories and results or counts for each category.",
"examples": [
{
"genders": {
"female": 51,
"male": 50
}
}
],
"properties": {},
"type": "object"
}
},
"required": [
"availability"
],
"type": "object"
},
"eventSize": {
"description": "Count of individuals in cohort at data point (for \u00b4user-defined\u00b4 cohorts, this is individuals meeting criteria) obtained from individual level info in database.",
"examples": [
1543,
42
],
"type": "integer"
},
"eventTimeline": {
"description": "Aggregated information of dates of visit/diagnostic/inclusion in study obtained from individual level info in database. Will coincide with collection event date for multi-time",
"properties": {
"end": {
"description": "latest date of visit",
"examples": [
"2018-10-01T13:23:45Z",
"2019-04-23T09:11:13Z",
"2017-01-17T20:33:40Z"
],
"format": "datetime",
"type": "string"
},
"start": {
"description": "earliest date of visit",
"examples": [
"2018-10-01T13:23:45Z",
"2019-04-23T09:11:13Z",
"2017-01-17T20:33:40Z"
],
"format": "datetime",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"type": "array"
},
"exclusionCriteria": {
"description": "Criteria used for defining the cohort. It is assumed that all cohort participants will match or NOT match such criteria.",
"properties": {
"ageRange": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age range definition. Provenance: GA4GH Phenopackets v2 `AgeRange`",
"properties": {
"end": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
},
"start": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
}
},
"title": "AgeRange",
"type": "object"
},
"diseaseConditions": {
"description": "Diseases in cohort inclusion criteria",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Diseases diagnosed e.g. to an individual, defined by diseaseID, age of onset, stage, level of severity, outcome and the presence of family history. Similarities to GA4GH Phenopackets v2 `Disease`",
"properties": {
"ageOfOnset": {
"$comments": "If using an ontology class the use of NCIT Age Group ontology term (NCIT:C20587) descendants is recommended.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a wrapper for various time descriptors. This follows the Phenopackets structure https://github.com/phenopackets/phenopacket-schema/blob/v2/docs/time-element.rst",
"oneOf": [
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
},
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age range definition. Provenance: GA4GH Phenopackets v2 `AgeRange`",
"properties": {
"end": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
},
"start": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
}
},
"title": "AgeRange",
"type": "object"
},
{
"$comments": "From https://github.com/phenopackets/phenopacket-schema/blob/v2/docs/gestational-age.rst",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Gestational age (or menstrual age) is the time elapsed between the first day of the last normal menstrual period and the day of delivery. The first day of the last menstrual period occurs approximately 2 weeks before ovulation and approximately 3 weeks before implantation of the blastocyst. Because most women know when their last period began but not when ovulation occurred, this definition traditionally has been used when estimating the expected date of delivery. In contrast, chronological age (or postnatal age) is the time elapsed after birth. Provenance: Phenopackets v2",
"properties": {
"days": {
"description": "Days beyond the completed weeks, if available.",
"examples": [
2,
4
],
"type": "integer"
},
"weeks": {
"description": "Completed weeks of gestation according to the above definition.",
"examples": [
4,
33
],
"type": "integer"
}
},
"required": [
"weeks"
],
"title": "GestationalAge",
"type": "object"
},
{
"description": "Time in date-time ISO8601 string format.",
"examples": [
"1999-08-05T17:21:00+01:00",
"2002-09-21T02:37:00-08:00"
],
"format": "date-time",
"type": "string"
},
{
"$comments": "From https://github.com/phenopackets/phenopacket-schema/blob/v2/docs/time-interval.rst",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Time interval with start and end defined as ISO8601 time stamps.",
"properties": {
"end": {
"description": "Time in date-time ISO8601 string format.",
"examples": [
"1999-08-05T17:21:00+01:00",
"2002-09-21T02:37:00-08:00"
],
"format": "date-time",
"type": "string"
},
"start": {
"description": "Time in date-time ISO8601 string format.",
"examples": [
"1999-08-05T17:21:00+01:00",
"2002-09-21T02:37:00-08:00"
],
"format": "date-time",
"type": "string"
}
},
"required": [
"start",
"end"
],
"title": "TimeInterval",
"type": "object"
},
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
}
],
"title": "TimeElement",
"type": "object"
},
"diseaseCode": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"familyHistory": {
"description": "Boolean indicating determined or self-reported presence of family history of the disease.",
"examples": [
true
],
"type": "boolean"
},
"notes": {
"description": "Unstructured text to describe additional properties of this disease instance.",
"examples": [
"Some free text"
],
"type": "string"
},
"severity": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"stage": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
}
},
"required": [
"diseaseCode"
],
"title": "Disease",
"type": "object"
},
"type": "array"
},
"ethnicities": {
"description": "Ethnias in cohort inclusion criteria",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"type": "array"
},
"genders": {
"description": "Gender(s) in cohort inclusion criteria",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"type": "array"
},
"locations": {
"description": "Geographic location(s) in cohort inclusion criteria",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"type": "array"
},
"phenotypicConditions": {
"description": "Phenotypic condition(s) in cohort inclusion criteria",
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"definitions": {},
"description": "Used to describe a phenotype that characterizes the subject or biosample.",
"properties": {
"evidence": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an evidence class. Provenance: GA4GH Phenopackets v2 `Evidence`",
"properties": {
"evidenceCode": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"reference": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an external reference class. Provenance: GA4GH Phenopackets v2 `ExternalReference`",
"properties": {
"id": {
"description": "An application specific identifier. RECOMMENDED.",
"example": "PMID:34054918",
"type": "string"
},
"notes": {
"description": "An optional text descriptor. Renamed compared to GA4GH Phenopackets v2 `ExternalReference.description`",
"example": "Signatures of Discriminative Copy Number Aberrations in 31 Cancer Subtypes",
"type": "string"
},
"reference": {
"description": "A url.",
"example": "https://www.ncbi.nlm.nih.gov/pmc/articles/PMC8155688/",
"type": "string"
}
},
"required": [],
"title": "ExternalReference",
"type": "object"
}
},
"required": [
"evidenceCode"
],
"title": "Evidence",
"type": "object"
},
"excluded": {
"default": false,
"description": "(from Phenopackets v.2) Flag to indicate whether the disease was observed or not. Default is \u2018false\u2019, in other words the disease was observed. Therefore it is only required in cases to indicate that the disease was looked for, but found to be absent. More formally, this modifier indicates the logical negation of the OntologyClass used in the 'featureType' field. CAUTION It is imperative to check this field for correct interpretation of the disease!",
"type": "boolean"
},
"featureType": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"modifiers": {
"description": "For instance one or more terms from HPO Clinical Modifier (HP:0012823). This subontology is designed to provide terms to characterize and specify the phenotypic abnormalities defined in the Phenotypic abnormality subontology, with respect to severity, laterality, age of onset, and other aspects. [ HPO:probinson ] ",
"examples": [
{
"id": "HP:0032500",
"label": "Exacerbated by tobacco use"
},
{
"id": "HP:4000053",
"label": "Displaced fracture"
}
],
"items": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"description": "Definition of an ontology term.",
"properties": {
"id": {
"description": "A CURIE identifier, e.g. as `id` for an ontology term.",
"examples": [
"ga4gh:GA.01234abcde",
"DUO:0000004",
"orcid:0000-0003-3463-0775",
"PMID:15254584"
],
"pattern": "^\\w[^:]+:.+$",
"type": "string"
},
"label": {
"description": "The text that describes the term. By default it could be the preferred text of the term, but is it acceptable to customize it for a clearer description and understanding of the term in an specific context.",
"type": "string"
}
},
"required": [
"id"
],
"title": "Ontology Term",
"type": "object"
},
"type": "array"
},
"notes": {
"description": "Unstructured text to describe additional properties of this phenotypic feature.",
"example": "Some free text",
"type": "string"
},
"onset": {
"$comments": "If using an ontology class the use of NCIT Age Group ontology term (NCIT:C20587) descendants is recommended.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Definition of a wrapper for various time descriptors. This follows the Phenopackets structure https://github.com/phenopackets/phenopacket-schema/blob/v2/docs/time-element.rst",
"oneOf": [
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
},
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age range definition. Provenance: GA4GH Phenopackets v2 `AgeRange`",
"properties": {
"end": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
},
"start": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Age value definition. Provenance: GA4GH Phenopackets v2 `Age`",
"properties": {
"iso8601duration": {
"description": "Represents age as a ISO8601 duration (e.g., P40Y10M05D).",
"example": "P32Y6M1D",
"type": "string"
}
},
"title": "Age",
"type": "object"
}
},
"title": "AgeRange",
"type": "object"
},