-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathga4gh-va-schema.yaml
2469 lines (2469 loc) · 97 KB
/
ga4gh-va-schema.yaml
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
name: GA4GH-VA-Spec
id: https://w3id.org/ga4gh-va
imports:
- linkml:types
prefixes:
linkml:
prefix_prefix: linkml
prefix_reference: https://w3id.org/linkml/
vaspec:
prefix_prefix: vaspec
prefix_reference: https://example.org/vaspec/
FHIR:
prefix_prefix: FHIR
prefix_reference: http://example.org/FHIR/
BFO:
prefix_prefix: BFO
prefix_reference: http://purl.obolibrary.org/obo/BFO_
IAO:
prefix_prefix: IAO
prefix_reference: http://purl.obolibrary.org/obo/IAO_
SEPIO:
prefix_prefix: SEPIO
prefix_reference: http://purl.obolibrary.org/obo/SEPIO_
CAM:
prefix_prefix: CAM
prefix_reference: http://example.org/CAM/
PROV:
prefix_prefix: PROV
prefix_reference: http://www.w3.org/ns/prov#
xsd:
prefix_prefix: xsd
prefix_reference: http://www.w3.org/2001/XMLSchema#
default_prefix: vaspec
default_range: string
types:
ga4ghString:
name: ga4ghString
description: A sequence of Unicode characters
title: ga4ghString
comments:
- The ga4ghString data type represents free-text that is not constrained to some
code set or associated with some semantic interpretation. It is the most generic
form of free-text literal in the model, and conceptually subsumes other ga4ghString-based
data types with more constrained interpretations (e.g. identifier, class, url).
base: string
uri: xsd:string
url:
name: url
description: A string representing a Uniform Resource Locator (RFC 1738), specifying
a web address where a resource can be found or information about the resource
discovered.
title: url
comments:
- 'Used in place of a plain string datatype when a resolvable web address for
a resource is desired. Common URL protocols are http{s}:, ftp:, mailto: and
mllp:, though many others are defined.'
base: ga4ghString
uri: xsd:string
class:
name: class
description: A string representing a class in a VA model used to type an object
in the data.
title: class
comments:
- This string must be the name of a concrete class from the core VA specification
(e.g. 'Statement'), or a specialization of such a class in a profile defined
by a particular implementation (e.g. TherapeuticEfficacyStatement').
base: ga4ghString
uri: xsd:string
ga4ghDateTime:
name: ga4ghDateTime
description: A string value that specifies a date and time of day comprised of
a year, month, day, hour, minute, and second, following the form “YYYY-MM-DDThh:mm:ss”
title: ga4ghDateTime
comments:
- Conventions for representing date + time defined here are based on the ISO 8601
standard. Hours of the day should use 24-hour time (e.g. 2PM = 14:00:00). A
time zone can be specified as described for ‘dates’ above, e.g. "1978-01-20T05:15:00Z,
and "1978-01-20T05:15:00+5:00". If precision down to time of day is not possible
or necessary, the hours, minutes, and seconds must still be provided due to
schema constraints, but can all be set to “00” and ignored at the instruction
of the message sender.
base: ga4ghString
uri: xsd:string
identifier:
name: identifier
description: A string value that uniquely identifies a specific instance of an
object in a dataset or document. Identifiers should be persistent, machine-resolvable,
and unique within their intended scope of use.
title: identifier
comments:
- We distinguish between two types of identifiers depending on their intended
scope of use. ‘Logical identifiers’ are used to identify a data object within
a given system, where it is used as a reference from other objects within the
same system (i.e. primary and foreign keys). The same data object copied to
a different system will likely have a different logical identifier in that new
system. ‘Business identifiers’ are typically provided by an external system
or authority, and are meant to be globally unique and persist across implementing
systems. A given entity or concept may have many business identifiers associated
with it, which can all be captured in a given data system. In the VA model,
we follow FHIR naming conventions and use an id attribute to hold the logical
identifier of a data object, and an identifier attribute to hold any business
identifiers that the data creator may also want to provide. Use of the W3C Compact
URI (CURIE) syntax to structure identifiers is strongly recommended, as a way
to ensure that a given identifier is unique within its intended scope of use.
base: ga4ghString
uri: xsd:string
ga4ghBoolean:
name: ga4ghBoolean
description: A binary data type that holds either a TRUE or FALSE value.
title: ga4ghBoolean
base: boolean
uri: xsd:boolean
slots:
extensionElement:
name: extensionElement
from_schema: https://w3id.org/ga4gh-va
localId:
name: localId
from_schema: https://w3id.org/ga4gh-va
globalIdentifier:
name: globalIdentifier
from_schema: https://w3id.org/ga4gh-va
type:
name: type
from_schema: https://w3id.org/ga4gh-va
label:
name: label
from_schema: https://w3id.org/ga4gh-va
alternativeLabel:
name: alternativeLabel
from_schema: https://w3id.org/ga4gh-va
description:
name: description
from_schema: https://w3id.org/ga4gh-va
hasURL:
name: hasURL
from_schema: https://w3id.org/ga4gh-va
reference:
name: reference
from_schema: https://w3id.org/ga4gh-va
xref:
name: xref
from_schema: https://w3id.org/ga4gh-va
thisRecordMeta:
name: thisRecordMeta
from_schema: https://w3id.org/ga4gh-va
sourceRecordMeta:
name: sourceRecordMeta
from_schema: https://w3id.org/ga4gh-va
isAbout:
name: isAbout
from_schema: https://w3id.org/ga4gh-va
qualifiedContribution:
name: qualifiedContribution
from_schema: https://w3id.org/ga4gh-va
dateAuthored:
name: dateAuthored
from_schema: https://w3id.org/ga4gh-va
wasSpecifiedBy:
name: wasSpecifiedBy
from_schema: https://w3id.org/ga4gh-va
derivedFrom:
name: derivedFrom
from_schema: https://w3id.org/ga4gh-va
wasOutputOf:
name: wasOutputOf
from_schema: https://w3id.org/ga4gh-va
hasPart:
name: hasPart
from_schema: https://w3id.org/ga4gh-va
partOf:
name: partOf
from_schema: https://w3id.org/ga4gh-va
isReportedIn:
name: isReportedIn
from_schema: https://w3id.org/ga4gh-va
confidenceLevel:
name: confidenceLevel
from_schema: https://w3id.org/ga4gh-va
confidenceScore:
name: confidenceScore
from_schema: https://w3id.org/ga4gh-va
version:
name: version
from_schema: https://w3id.org/ga4gh-va
license:
name: license
from_schema: https://w3id.org/ga4gh-va
dataItemType:
name: dataItemType
from_schema: https://w3id.org/ga4gh-va
value:
name: value
from_schema: https://w3id.org/ga4gh-va
unit:
name: unit
from_schema: https://w3id.org/ga4gh-va
variability:
name: variability
from_schema: https://w3id.org/ga4gh-va
confidenceInterval:
name: confidenceInterval
from_schema: https://w3id.org/ga4gh-va
componentDataItem:
name: componentDataItem
from_schema: https://w3id.org/ga4gh-va
dataSetType:
name: dataSetType
from_schema: https://w3id.org/ga4gh-va
dataSetLevel:
name: dataSetLevel
from_schema: https://w3id.org/ga4gh-va
releaseDate:
name: releaseDate
from_schema: https://w3id.org/ga4gh-va
previousVersion:
name: previousVersion
from_schema: https://w3id.org/ga4gh-va
currentVersion:
name: currentVersion
from_schema: https://w3id.org/ga4gh-va
format:
name: format
from_schema: https://w3id.org/ga4gh-va
conformsTo:
name: conformsTo
from_schema: https://w3id.org/ga4gh-va
documentType:
name: documentType
from_schema: https://w3id.org/ga4gh-va
title:
name: title
from_schema: https://w3id.org/ga4gh-va
statementType:
name: statementType
from_schema: https://w3id.org/ga4gh-va
subject:
name: subject
from_schema: https://w3id.org/ga4gh-va
predicate:
name: predicate
from_schema: https://w3id.org/ga4gh-va
object:
name: object
from_schema: https://w3id.org/ga4gh-va
qualifier:
name: qualifier
from_schema: https://w3id.org/ga4gh-va
negated:
name: negated
from_schema: https://w3id.org/ga4gh-va
assertedProposition:
name: assertedProposition
from_schema: https://w3id.org/ga4gh-va
evidenceLevel:
name: evidenceLevel
from_schema: https://w3id.org/ga4gh-va
evidenceScore:
name: evidenceScore
from_schema: https://w3id.org/ga4gh-va
hasEvidenceLine:
name: hasEvidenceLine
from_schema: https://w3id.org/ga4gh-va
hasEvidence:
name: hasEvidence
from_schema: https://w3id.org/ga4gh-va
hasEvidenceOfType:
name: hasEvidenceOfType
from_schema: https://w3id.org/ga4gh-va
hasEvidenceFromSource:
name: hasEvidenceFromSource
from_schema: https://w3id.org/ga4gh-va
subjectDescriptor:
name: subjectDescriptor
from_schema: https://w3id.org/ga4gh-va
objectDescriptor:
name: objectDescriptor
from_schema: https://w3id.org/ga4gh-va
qualifierDescriptor:
name: qualifierDescriptor
from_schema: https://w3id.org/ga4gh-va
studyResultType:
name: studyResultType
from_schema: https://w3id.org/ga4gh-va
focus:
name: focus
from_schema: https://w3id.org/ga4gh-va
data:
name: data
from_schema: https://w3id.org/ga4gh-va
interpretation:
name: interpretation
from_schema: https://w3id.org/ga4gh-va
sourceDataSet:
name: sourceDataSet
from_schema: https://w3id.org/ga4gh-va
sourceStudy:
name: sourceStudy
from_schema: https://w3id.org/ga4gh-va
sourceStudyType:
name: sourceStudyType
from_schema: https://w3id.org/ga4gh-va
sourceStudyDate:
name: sourceStudyDate
from_schema: https://w3id.org/ga4gh-va
sourceStudyMethod:
name: sourceStudyMethod
from_schema: https://w3id.org/ga4gh-va
evidenceLineType:
name: evidenceLineType
from_schema: https://w3id.org/ga4gh-va
targetProposition:
name: targetProposition
from_schema: https://w3id.org/ga4gh-va
hasEvidenceItem:
name: hasEvidenceItem
from_schema: https://w3id.org/ga4gh-va
evidenceDirection:
name: evidenceDirection
from_schema: https://w3id.org/ga4gh-va
evidenceStrength:
name: evidenceStrength
from_schema: https://w3id.org/ga4gh-va
evidenceItemSource:
name: evidenceItemSource
from_schema: https://w3id.org/ga4gh-va
methodType:
name: methodType
from_schema: https://w3id.org/ga4gh-va
activityType:
name: activityType
from_schema: https://w3id.org/ga4gh-va
startDate:
name: startDate
from_schema: https://w3id.org/ga4gh-va
endDate:
name: endDate
from_schema: https://w3id.org/ga4gh-va
performedBy:
name: performedBy
from_schema: https://w3id.org/ga4gh-va
hadInput:
name: hadInput
from_schema: https://w3id.org/ga4gh-va
hadOutput:
name: hadOutput
from_schema: https://w3id.org/ga4gh-va
researchStudyType:
name: researchStudyType
from_schema: https://w3id.org/ga4gh-va
contributionMadeBy:
name: contributionMadeBy
from_schema: https://w3id.org/ga4gh-va
contributionMadeTo:
name: contributionMadeTo
from_schema: https://w3id.org/ga4gh-va
contributorRole:
name: contributorRole
from_schema: https://w3id.org/ga4gh-va
organizationalContext:
name: organizationalContext
from_schema: https://w3id.org/ga4gh-va
agentType:
name: agentType
from_schema: https://w3id.org/ga4gh-va
softwareVersion:
name: softwareVersion
from_schema: https://w3id.org/ga4gh-va
hasAffiliation:
name: hasAffiliation
from_schema: https://w3id.org/ga4gh-va
parentOrganization:
name: parentOrganization
from_schema: https://w3id.org/ga4gh-va
childOrganization:
name: childOrganization
from_schema: https://w3id.org/ga4gh-va
propositionType:
name: propositionType
from_schema: https://w3id.org/ga4gh-va
member:
name: member
from_schema: https://w3id.org/ga4gh-va
organization:
name: organization
from_schema: https://w3id.org/ga4gh-va
organizationalRole:
name: organizationalRole
from_schema: https://w3id.org/ga4gh-va
affiliationStatus:
name: affiliationStatus
from_schema: https://w3id.org/ga4gh-va
valueObjectId:
name: valueObjectId
from_schema: https://w3id.org/ga4gh-va
valueObject:
name: valueObject
from_schema: https://w3id.org/ga4gh-va
valueObjectName:
name: valueObjectName
from_schema: https://w3id.org/ga4gh-va
valueObjectAlias:
name: valueObjectAlias
from_schema: https://w3id.org/ga4gh-va
valueObjectExpression:
name: valueObjectExpression
from_schema: https://w3id.org/ga4gh-va
valueObjectDescription:
name: valueObjectDescription
from_schema: https://w3id.org/ga4gh-va
valueObjectXref:
name: valueObjectXref
from_schema: https://w3id.org/ga4gh-va
moleculeContext:
name: moleculeContext
from_schema: https://w3id.org/ga4gh-va
structuralType:
name: structuralType
from_schema: https://w3id.org/ga4gh-va
code:
name: code
from_schema: https://w3id.org/ga4gh-va
system:
name: system
from_schema: https://w3id.org/ga4gh-va
systemURL:
name: systemURL
from_schema: https://w3id.org/ga4gh-va
systemVersion:
name: systemVersion
from_schema: https://w3id.org/ga4gh-va
name:
name: name
from_schema: https://w3id.org/ga4gh-va
recordIdentifier:
name: recordIdentifier
from_schema: https://w3id.org/ga4gh-va
partOfDataset:
name: partOfDataset
from_schema: https://w3id.org/ga4gh-va
recordVersion:
name: recordVersion
from_schema: https://w3id.org/ga4gh-va
dateRecordCreated:
name: dateRecordCreated
from_schema: https://w3id.org/ga4gh-va
dateRecordLastModified:
name: dateRecordLastModified
from_schema: https://w3id.org/ga4gh-va
recordURL:
name: recordURL
from_schema: https://w3id.org/ga4gh-va
componentDisease:
name: componentDisease
from_schema: https://w3id.org/ga4gh-va
componentPhenotype:
name: componentPhenotype
from_schema: https://w3id.org/ga4gh-va
inheritancePattern:
name: inheritancePattern
from_schema: https://w3id.org/ga4gh-va
contributingGene:
name: contributingGene
from_schema: https://w3id.org/ga4gh-va
componentDrug:
name: componentDrug
from_schema: https://w3id.org/ga4gh-va
componentProcedure:
name: componentProcedure
from_schema: https://w3id.org/ga4gh-va
componentActivity:
name: componentActivity
from_schema: https://w3id.org/ga4gh-va
drugOperator:
name: drugOperator
from_schema: https://w3id.org/ga4gh-va
biotype:
name: biotype
from_schema: https://w3id.org/ga4gh-va
symbol:
name: symbol
from_schema: https://w3id.org/ga4gh-va
location:
name: location
from_schema: https://w3id.org/ga4gh-va
strand:
name: strand
from_schema: https://w3id.org/ga4gh-va
classes:
Element:
name: Element
exact_mappings:
- FHIR:Element
description: The base definition for all elements that comprise the model (classes,
complex data types, value sets)
title: Element
comments:
- This class is useful to reference as the range of attributes that can take instances
of a class or a complex data type (e.g. a Coding) as their value (e.g. Statement.object)
from_schema: https://w3id.org/ga4gh-va
slots:
- extensionElement
slot_usage:
extensionElement:
name: extensionElement
description: A key-value data structure that allows definition of custom fields
to capture information not directly supported by the VA specification.
comments:
- The VA-Spec provides implementers the ability to extend any model elements
with new attributes using this flexible Extension element.
multivalued: true
range: Extension
required: false
Entity:
name: Entity
aliases:
- Thing
exact_mappings:
- BFO:0000001
description: Anything that exists, has existed, or will exist.
title: Entity
comments:
- Entity is the root class of ‘core’ classes model - those that have identifiers
and other general metadata like labels, xrefs, urls, descriptions, etc. All
core classes descend from and inherit its attributes.
from_schema: https://w3id.org/ga4gh-va
is_a: Element
slots:
- localId
- globalIdentifier
- type
- label
- alternativeLabel
- description
- hasURL
- reference
- xref
- thisRecordMeta
- sourceRecordMeta
slot_usage:
localId:
name: localId
exact_mappings:
- FHIR:id
description: The logical identifier of the entity in the system of record,
e.g. a UUID. This 'id' is unique within a given system. The identified
entity may have a different 'id' in a different system.
comments:
- FHIR naming conventions are followed here, where an 'id' field holds logical
identifiers which are unique only within a given system, and an 'identifier'
field holds business identifiers, which are globally unique and used to
connect entities and share content across systems.
multivalued: false
range: identifier
required: true
globalIdentifier:
name: globalIdentifier
exact_mappings:
- FHIR:identifier
description: A business identifier or accession number for the entity, typically
as provided by an external system or authority, that is globally unique
and persists across implementing systems.
comments:
- FHIR naming conventions are followed here, where an 'id' field holds logical
identifiers which are unique only within a given system, and an 'identifier'
field holds business identifiers, which are globally unique and used to
connect entities and share content across systems.
multivalued: true
range: identifier
required: false
type:
name: type
description: The schema class that is instantiated by the data object. Must
be the name of a class from the VA schema.
multivalued: false
range: class
required: true
label:
name: label
description: A primary name for the Entity.
multivalued: false
range: string
required: false
alternativeLabel:
name: alternativeLabel
description: An alternative name for the Entity.
multivalued: true
range: string
required: false
description:
name: description
description: A free text description of the Entity.
multivalued: false
range: string
required: false
hasURL:
name: hasURL
description: The URL/web address of a digital resource representing the entity,
or providing information about it.
multivalued: true
range: url
required: false
reference:
name: reference
description: A document or other Information Entity that describes the Entity.
multivalued: true
range: InformationEntity
required: false
xref:
name: xref
description: A cross-reference to database identifier(s) representing the
same or a closely related entity or concept as the Entity.
comments:
- Preferred values for this field are CURIEs or URLs for database records
multivalued: true
range: string
required: false
thisRecordMeta:
name: thisRecordMeta
description: A reusable structure that encapsulates provenance metadata about
the present record/data object (as opposed to provenance information about
the real world entity this record/data object represents).
comments:
- Record-level metadata applies to a specific concrete encoding/serialization
of knowledge (e.g as a record in a specific database, or an online digital
resource). A RecordMetadata object can capture provenance and other metadata,
including when, how, and by whom a specific record was generated or modified;
what upstream resources it was derived/retrieved from; and record-level
administrative information such as versioning and system / lifecycle status.
multivalued: false
range: RecordMetadata
required: false
sourceRecordMeta:
name: sourceRecordMeta
description: A reusable structure that encapsulates provenance metadata that
applies to an upstream record/data objdct about the Entity, from which content
of the present record was derived.
comments:
- The 'sourceRecordMeta' attribute holds a RecordMetadata object that carries
information about a separate, upstream source record from which the present
record derived its content. This attribute is only used in edge cases where
the data creator wants to caopture metadata about usptream source records.
multivalued: true
range: RecordMetadata
required: false
InformationEntity:
name: InformationEntity
aliases:
- Information Content Entity, ICE
exact_mappings:
- IAO:0000030 | FRBR:Work
description: An abstract (non-physical) entity that is about something.
title: Information Entity
comments:
- Information Entities represent the abstract 'information content' encoded in
physical or digital artifacts such as books, photographs, files, web pages,
the neural connections of a human brain, etc. They are independent of any specific
language, representational format, or physical/digital medium. In the FRBR model,
this corresponds to the 'Works' level of representation.
from_schema: https://w3id.org/ga4gh-va
is_a: Entity
slots:
- isAbout
- qualifiedContribution
- dateAuthored
- wasSpecifiedBy
- derivedFrom
- wasOutputOf
- hasPart
- partOf
- isReportedIn
- confidenceLevel
- confidenceScore
- version
- license
slot_usage:
isAbout:
name: isAbout
description: An entity or concept in the world that the information entity
describes/is about.
comments:
- This field can be used to tag a Statement object with things it is about,
in lieu of providing a more precise description of what the Statement asserts
to be true using subject, predicate, object, and qualifier fields.
multivalued: true
range: Entity
required: false
qualifiedContribution:
name: qualifiedContribution
description: A specific contribution made by some Agent to the creation, modification,
or validation of the information represented in the Information Entity.
comments:
- This attribute points to a Contribution object, which holds a structured
description of the actions taken by a particular agent in contributing to
an Information Entity.
multivalued: true
range: Contribution
required: false
dateAuthored:
name: dateAuthored
description: The date the information content expressed in this entity was
generated.
comments:
- We use the term 'authored' to refer to the generation of information in
the abstract - i.e. the information content expressed in a Statement, not
a concrete encoding of it in a specific language or format. The 'dateAuthored'
attribute captures when this abstract information content was first created. Information
about when a particular concrete encoding of this information was created
(e.g. as a VA-based json object) would live in a RecordMetadata object attached
to the Information Entity).
multivalued: false
range: ga4ghDateTime
required: false
wasSpecifiedBy:
name: wasSpecifiedBy
description: A plan specification that describes all or part of the process
through which the information was generated.
comments:
- Depending on the type of plan spcification, these may be called 'protocols',
'guidelines', 'methods', 'rule sets', etc.
multivalued: true
range: Method
required: false
derivedFrom:
name: derivedFrom
exact_mappings:
- DC:source
description: An information resource from which the Information Entity is
derived, in whole or in part
multivalued: true
range: InformationEntity
required: false
wasOutputOf:
name: wasOutputOf
description: An activity that generated the Entity.
multivalued: true
range: Activity
required: false
hasPart:
name: hasPart
description: Any part of the Information Entity (e.g. individual value or
record from a larger data set, a section of a larger document)
multivalued: true
range: InformationEntity
required: false
partOf:
name: partOf
description: A larger Information Entity of which the present Information
Entity is a part.
multivalued: true
range: InformationEntity
required: false
isReportedIn:
name: isReportedIn
description: A document in which the information content carried by the Information
Entity is expressed
comments:
- This attribute is used specifically to reference documents/publications
where the Information Entity is expressed or reported. For a Statement,
this might be a publication where the authors express the statement in text. For
a Data Item, this might be a publication with a table or figure that reports
the value of the data. Note that the VA-Spec provide separate attributes
for describing different types of 'references' from an Information Entity
to a Document (e.g. hasEvidenceFromSource is used by a Statement to reference
a Document that provided evidence for the knowldege the Statement expresses.
multivalued: true
range: Document
required: false
confidenceLevel:
name: confidenceLevel
description: A qualitative term describing the degree of confidence held by
the creator of the information entity, that the information it represents
is true (e.g. 'high confidence', 'likely true', 'low confidence').
comments:
- What a confidence level or score reflects may vary depending on the type
of InformationEntity it describes. For Statements, it may reflect an agent's
confidence that the statement asserts a proposition that is true. For a
DataItem, its may reflect an agent's confidence that the value is an accurate
reflection of the reality it measures or describes. For an Image, this may
reflect the agent's confidence that it accurately represents the subject
it depicts.
multivalued: false
range: Coding
required: false
confidenceScore:
name: confidenceScore
description: A quantitative score reflecting the degree of confidence held
by the creator of the information entity, that the information it represents
is true.
multivalued: false
range: DataItem
required: false
version:
name: version
description: The version of the Information Entity (to be used in cases where
version is not reflected in the id or identifiers associated with the entity).
comments:
- Note that this attribute captures the version of the abstract information
content that comproses the Information Entity - in cases where updated versions
of the entity are released. Versioning of specific concrete records/encodings
of the information in a particular format/syntax are to be captured in the
recordVersion field of a RecordMeadata object associated with the Information
Entity.
multivalued: false
range: string
required: false
license:
name: license
description: The type of license that dictates legal permissions for how a
resource (e.g. dataset, document, protocol) can be used - typically referenced
by its URL.
multivalued: false
range: string
required: false
DataItem:
name: DataItem
exact_mappings:
- IAO:0000027
description: An InformationEntity representing an individual piece of data, generated/acquired
through methods which reliably produce truthful information about something.
title: Data Item
comments:
- Examples include raw observations or measurements such as an allele count, or
patient's weight, derived calculations such as frequency or mean, and computed
statistical scores/metrics such as p-values and z-scores.
from_schema: https://w3id.org/ga4gh-va
is_a: InformationEntity
slots:
- dataItemType
- value
- unit
- variability
- confidenceInterval
- componentDataItem
slot_usage:
dataItemType:
name: dataItemType
description: A specific type of data the DataItem object represents (e.g.
a specimen count, a patient weight, an allele frequency, a p-value)
multivalued: true
range: Coding
required: false
value:
name: value
description: The value of the data item
multivalued: false
range: string
required: true
unit:
name: unit
description: A unit of measure for the value
multivalued: false
range: Coding
required: false
variability:
name: variability
description: A score describing the variability inherent in a data item representing
a statistical summary of a set of observations/measurements (e.g. the standard
deviation associated with a statistical mean calculated across several experimental
replicates).
comments:
- Examples of statistical measures of variability include an Interquartile
Range, Variance, Standard Deviation, Standard Error.
multivalued: true
range: DataItem
required: false
confidenceInterval:
name: confidenceInterval
description: A measure of the probability that a parameter of interest will
fall within a defined range of values around a mean or other statistical
calculation.
comments:
- 'Confidence intervals reflect the degree of uncertainty in a sampling method.
They may be bounded on one or both sides, and are computed for a designated
confidence level (most often 95% or 99%. Example: A Hazard Ratio of 0.47
might have a 95% confidence interval between 0.34 and 0.65, wiht a p-value
of = 0.001.'
multivalued: false
range: DataItem
required: false
componentDataItem:
name: componentDataItem
description: A more foundational data item that is a logical component of
a compound data item.
comments:
- Examples of 'compound' data items with componet parts include a confidence
interval, which is comprised of data items representing its lower and upper
bounds, and a blood pressure reading, which is comprised of separate systolic
and diastolic measurements.
multivalued: true
range: DataItem
required: false
DataSet:
name: DataSet
exact_mappings:
- IAO:0000100
description: A collection of related data items or records that are organized
together in a common format or structure, to enable their computational manipulation
as a unit.
title: Data Set
comments:
- Examples include the Broad ExAC dataset on allele population frequency, or a
SIFT dataset of computational predictions functional impact for a set of variants,
or the contents of a VCF file that describes variations observed in a particular
patient and various annotations made on them.
from_schema: https://w3id.org/ga4gh-va
is_a: InformationEntity
slots:
- dataSetType
- dataSetLevel
- releaseDate
- license
- version
- previousVersion
- currentVersion
- format
- conformsTo
slot_usage:
dataSetType:
name: dataSetType
description: A specific type of data set the DataSet object represents.
comments:
- The recorded type is typically based on the nature of the data in the dataset,
and what it describes (e.g. genomic sequence dataset, genome feature annotation
dataset) .
multivalued: true
range: Coding
required: false
dataSetLevel:
name: dataSetLevel
description: The level at which the Data Set is considered and described ('Summary'
level, 'Version' level, or 'Distribution' level - see https://www.w3.org/TR/hcls-dataset/#datasetdescriptionlevels)
comments:
- 'The VA model adopts the W3C HCLS DataSet Model view that DataSets can be
considered and described at three levels: - The ''Summary'' level considers
the Data Set at the most abstract/general level, independent of a specific
version or format. - The ''Version'' level considers a specific version
of a Data Set, which may acquire version-specific characteristics (e.g.
a release date). - The ''Distribution'' level considers a specific format/encoding
of a dataset version, which may acquire distribution-specific characteristics
(e.g. a format, or downloadURL). Attributes defined for the DataSet class
may apply at all or only some of the ‘levels’ described above. Guidance
in this regard is provided in comments on each attribute, and should be
followed when creating DataSet objects.'
multivalued: false
range: Coding
required: false
releaseDate:
name: releaseDate
description: The date when a version-level Data Set was released.
comments:
- This attribute may apply to version and distribution-level Data Set representations.
multivalued: false
range: ga4ghDateTime
required: false
license:
name: license
description: The type of license that dictates legal permissions for how the
Data Set can be used - typically referenced by its URL.
comments:
- The VA Model can record license information for resources such as Data Sets
and Documents that get published and released as a unit for community use.
This attribute may apply to summary, version, and distribution-level Data
Set representations.
multivalued: false
range: string
required: false
version:
name: version
description: The version of the Data Set (use this field used in cases where
version is not reflected in an identifier associated with the Data Set)
comments:
- The VA Model can record version information for resources such as Data Sets
and Documents that get published and released as a unit for community use.
These may go through rounds of revisions that add or modify content, but
don’t change the identity of the resource. This attribute may apply to
version and distribution-level Data Set representations.
multivalued: false
range: string
required: false
previousVersion:
name: previousVersion
description: A version-level Data Set representing the version described here.
comments:
- This attribute may apply to version and distribution-level Data Set representations.
multivalued: false
range: DataSet
required: false
currentVersion:
name: currentVersion
description: A version-level Data Set representing the most current version
at the time of recording.
comments:
- This attribute may apply to version and distribution-level Data Set representations.
multivalued: false
range: DataSet
required: false
format:
name: format