-
Notifications
You must be signed in to change notification settings - Fork 5
/
cde.schema.json
617 lines (616 loc) · 23.5 KB
/
cde.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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/element_set",
"$id": "https://github.com/ACR-RSNA-CDEs/blob/v1.0.0/cde.schema.json",
"definitions": {
"element_set": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^\\$": {
"description": "Any property starting with $ is reserved for notations and extensions",
"tsType": "any"
}
},
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^RDES\\d+",
"examples": ["RDES42", "RDES1042"]
},
{
"type": "string",
"pattern": "TO_BE_DETERMINED\\d+",
"examples": ["TO_BE_DETERMINED123"],
"description": "The TO_BE_DETERMINED123 pattern is used for author convenience and tracking during the authoring process. Upon submission to the radelement archive a set number will be assigned and used for all further references overwriting this value"
}
]
},
"name": {
"type": "string",
"description" :"Set names should follow conventions listed here: https://rsna.github.io/ACR-RSNA-CDEs/reference/set/"
},
"description": {
"type": "string",
"description": "CDE Set description including the expected clinical use case. Plain text, or XHTML div are acceptable"
},
"set_version": {
"$ref": "#/definitions/version"
},
"schema_version": {
"$ref": "#/definitions/schema_version"
},
"current_status": {
"$ref": "#/definitions/status"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/definitions/status"
},
"minItems": 1
},
"url": {
"type": "string",
"format": "uri",
"description": "A link to the set on radelement.org"
},
"index_codes": {
"type": "array",
"items": {
"$ref": "#/definitions/index_code"
},
"minItems": 1
},
"body_parts": {
"type": "array",
"items": {
"$ref": "#/definitions/body_part"
},
"minItems": 1
},
"contributors": {
"type": "object",
"$ref": "#/definitions/contributors"
},
"specialties": {
"type": "array",
"items": {
"$ref": "#/definitions/specialty"
},
"minItems": 1
},
"modalities": {
"type": "array",
"items": {
"$ref": "#/definitions/modality"
},
"minItems": 1
},
"elements": {
"type": "array",
"description": "When authoring (e.g., PUT/POST), published elements can be referenced (element_ref_id). GET requests return full element definitions",
"items": {
"anyOf": [
{
"type": "object",
"$ref": "#/definitions/element"
},
{
"type": "object",
"properties": {
"element_ref_id": {"type": "string"},
"element_version": {"type": "number"}
},
"additionalProperties": false,
"required": ["element_ref_id", "element_version"]
}
]
},
"minItems": 1
},
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/image"
},
"minItems": 1
},
"references": {
"type": "array",
"items": {
"$ref": "#/definitions/reference"
},
"minItems": 1
}
},
"required": ["id", "name", "description", "set_version", "current_status", "elements", "specialties", "schema_version"]
},
"element": {
"type": "object",
"additionalProperties": false,
"description": "Each data element has a unique id and a textual name.",
"properties": {
"id": {
"anyOf": [
{
"type": "string",
"pattern": "^RDE\\d+",
"examples": ["RDES42", "RDES1042"]
},
{
"type": "string",
"pattern": "TO_BE_DETERMINED\\d+",
"examples": ["TO_BE_DETERMINED123"],
"description": "The TO_BE_DETERMINED123 pattern is used for author convenience and tracking during the authoring process. Upon submission to the radelement archive an element number will be assigned and used for all further references overwriting this value"
}
]
},
"parent_set": {
"anyOf": [
{
"type": "string",
"pattern": "^RDES\\d+",
"examples": ["RDES42", "RDES1042"]
},
{
"type": "string",
"pattern": "TO_BE_DETERMINED\\d+",
"description": "The TO_BE_DETERMINED123 pattern is used for author convenience and tracking during the authoring process. Upon submission to the radelement archive RDES will be assigned and used for all further references overwriting this value"
}
]
},
"name": {
"type": "string",
"description" :"Element names consistent with https://rsna.github.io/ACR-RSNA-CDEs/reference/element/"
},
"definition": {
"description": "A human readable definition explaining the clinical context of the data element",
"type": "string"
},
"question": {
"description": "How a user might be prompted to provide a value",
"type": "string"
},
"element_version": {
"$ref": "#/definitions/version"
},
"schema_version": {
"$ref": "#/definitions/schema_version"
},
"current_status": {
"$ref": "#/definitions/status"
},
"index_codes": {
"type": "array",
"items": {
"$ref": "#/definitions/index_code"
},
"minItems": 1
},
"body_parts": {
"type": "array",
"items": {
"$ref": "#/definitions/body_part"
},
"minItems": 1
},
"modalities": {
"type": "array",
"items": {
"$ref": "#/definitions/modality"
},
"minItems": 1
},
"contributors": {
"type": "object",
"$ref": "#/definitions/contributors"
},
"history": {
"type": "array",
"items": {
"$ref": "#/definitions/status"
},
"minItems": 1
},
"specialty": {
"type": "array",
"items": {
"$ref": "#/definitions/specialty"
},
"minItems": 1
},
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/image"
},
"minItems": 1
},
"references": {
"type": "array",
"items": {
"$ref": "#/definitions/reference"
},
"minItems": 1
},
"integer_value": {
"$ref": "#/definitions/integer_value"
},
"value_set": {
"$ref": "#/definitions/value_set"
},
"float_value": {
"$ref": "#/definitions/float_value"
}
},
"required": ["id", "name", "element_version", "current_status", "schema_version"],
"oneOf": [
{
"required": ["integer_value"]
},
{
"required": ["value_set"]
},
{
"required": ["float_value"]
}
]
},
"image": {
"type": "object",
"description": "URLs to specify exemplar images. Currently supported at the set, element, or value levels",
"additionalProperties": false,
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"height": {
"type": "integer",
"exclusiveMinimum": 0
},
"width": {
"type": "integer",
"exclusiveMinimum": 0
},
"caption": {
"type": "string"
},
"rights": {
"type": "string"
},
"contributors": {
"type": "object",
"$ref": "#/definitions/contributors"
},
"references": {
"type": "array",
"items": {
"$ref": "#/definitions/reference"
},
"minItems": 1
}
},
"required": ["url"]
},
"contributors": {
"type": "object",
"description": "People and organizations who have contributed to the CDE and an indication of their role",
"additionalProperties": false,
"properties": {
"people": {
"type": "array",
"items": {
"$ref": "#/definitions/person"
},
"minItems": 1
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/organization"
},
"minItems": 1
}
},
"required": ["people"]
},
"person": {
"type": "object",
"description": "Specifies someone who has contributed to an Element or Set. E-mail is the unique identifier used to match people between systems",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
},
"affiliation": {
"type": "string"
},
"orcid_id": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"role": {
"type": "string",
"enum": ["Author", "Editor", "Translator", "Reviewer"]
}
},
"required": ["name", "email", "role"]
},
"body_part": {
"type": "object",
"description": "References to external ontologies describing the body part referenced by the set or element",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"index_codes": {
"$ref": "#/definitions/index_code"
}
},
"required": ["name"]
},
"index_code": {
"type": "object",
"description": "Used in set, element, and value definitions to link to external ontologies",
"additionalProperties": false,
"properties": {
"system": {
"type": "string",
"enum": ["RADLEX", "SNOMEDCT", "LOINC", "ACRCOMMON"]
},
"code": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"display": {
"type": "string"
}
}
},
"integer_value": {
"type": "object",
"description": "Defines structure for integer elements",
"additionalProperties": false,
"properties": {
"min": {
"description": "Value must be greater than or equal to minimum.",
"type": "integer"
},
"max": {
"description": "Value must be less than or equal to the maximum.",
"type": "integer"
},
"step": {
"default": 1,
"type": "integer"
},
"unit": {
"type": "string",
"description": "Use UCUM (https://ucum.org/) compatible units"
}
}
},
"float_value": {
"type": "object",
"description": "Defines structure for float (decimal) elements",
"additionalProperties": false,
"properties": {
"min": {
"description": "Value must be greater than or equal to minimum.",
"type": "number"
},
"max": {
"description": "Value must be less than or equal to the maximum.",
"type": "number"
},
"step": {
"type": "number"
},
"unit": {
"type": "string"
}
}
},
"modality":{
"type":"object",
"description": "Used in set and element defintions to specify applicable imaging modalities (optional)",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": ["CT", "FL", "MR", "MG", "NM", "PET", "US", "XR"],
"description": "Definition for specifying an applicable modality using DICOM modality codes"
}
}
},
"organization": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"abbreviation": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"comment": {
"type": "string"
},
"role": {
"type": "string",
"enum": ["Author", "Sponsor", "Translator", "Contributor"]
}
},
"required": ["name"]
},
"value_set": {
"type": "object",
"description": "Specifies an enumerated list of text choices for an element",
"additionalProperties": false,
"properties": {
"min_cardinality": {
"description": "defines the minimum number of values to select from the value set",
"type": "integer",
"minimum": 0
},
"max_cardinality": {
"description": "defines the maximum number of values to select from the value set",
"type": "integer",
"minimum": 1
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/value"
},
"minItems": 2
}
},
"required": ["values", "min_cardinality"]
},
"value": {
"type": "object",
"description": "An individual answer to an element question",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "A unique machine readable identifier for each choice in a value set made up of the parent element id, period, and a number. The number following the period begins with zero and is assigned upon first submission of the element to the radelement archive.",
"anyOf": [
{
"pattern": "RDE\\d+\\.\\d+",
"examples": ["RDE25.0", "RDE25.1"]
},
{
"pattern": "TO_BE_DETERMINED\\d+.\\d+",
"examples": ["TO_BE_DETERMINED123.0"],
"description": "The TO_BE_DETERMINED123 pattern is used for author convenience and tracking during the authoring process. Upon submission to the radelement archive a set number will be assigned and used for all further references overwriting this value"
}
]
},
"value": {
"type": "string",
"description": "Element value is intended to provide a human and/or machine readable string that could be use to caluculate a score, identify a position on a decision tree",
"examples": ["2", "5", "Non-Viable"]
},
"name": {
"type": "string",
"description": "Human readable answer to the question"
},
"definition": {
"type": "string",
"description": "Human readable definiton of the value in the specific clinical context"
},
"index_codes": {
"type": "array",
"items": {
"$ref": "#/definitions/index_code"
},
"minItems": 1
},
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/image"
},
"minItems": 1
}
},
"required": ["name", "code"]
},
"specialty": {
"type": "object",
"description": "Radiology subspecialties relevant to the set or element. Uses RSNA's standardized two-letter abbreviations",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"abbreviation": {
"type": "string",
"enum": ["AB", "BR", "CA", "CH", "ER", "GI", "GU", "HN", "IR", "MI", "MK", "NR", "OB", "OI", "OT", "PD", "QI", "RS", "VA"]
}
},
"required": ["name", "abbreviation"]
},
"version": {
"type": "object",
"description": "This is an auto- increment field that increases by one each time a set is added to radelement",
"additionalProperties": false,
"properties": {
"number": {
"type": "integer",
"minimum": 1
},
"date": {
"type": "string",
"format": "date"
}
},
"required": ["date", "number"],
"title": "Version"
},
"schema_version": {
"type": "string",
"description": "Identifies which schema version/release the set or element conforms to (e.g. 1.0.0, 2.0.0) follows semver.org conventions",
"pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
},
"status": {
"type": "object",
"description": "This defines the status of the set or element (Proposed, Published, or Retiered and records the date of last action",
"properties": {
"date" : {
"type": "string",
"format": "date"
},
"status": {
"type": "string",
"enum": ["Proposed", "Published", "Retired"]
}
},
"required": ["date", "status"]
},
"reference": {
"type": "object",
"description": "Bibliographic citations, including all the author names (no et Al)",
"additionalProperties": false,
"properties": {
"citation": {
"type": "string"
},
"doi_url": {
"type": "string",
"format": "uri"
},
"pubmed_id": {
"type": "string",
"format": "integer"
},
"url": {
"type": "string",
"format": "uri"
}
},
"required": ["citation"]
}
}
}