-
Notifications
You must be signed in to change notification settings - Fork 5
/
KPIs_api.yaml
86 lines (85 loc) · 2.65 KB
/
KPIs_api.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
openapi: 3.0.0
info:
version: '0.1'
title: 'KPIs API'
description: 'Virtual Platform Key Performance Indicators (KPIs) API'
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
paths:
/KPIs/{diseaseID}/onset-firstVisit:
description: Get time from onset to first HCP visit based on the disease of the patients.
get:
parameters:
- $ref: '#/components/parameters/DiseaseParam'
responses:
200:
description: Successful Query.
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessfulResponse'
400:
description: The server cannot process the request due to a client error.
404:
description: Requested resource not found.
/KPIs/{diseaseID}/onset-therapy:
description: Get time from onset to the therapy or treatment based on the disease of the patients.
get:
parameters:
- $ref: '#/components/parameters/DiseaseParam'
responses:
200:
description: Successful Query.
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessfulResponse'
400:
description: The server cannot process the request due to a client error.
404:
description: Requested resource not found.
/KPIs/{diseaseID}/onset-diagnosis:
description: Get time from onset to the diagnosis based on the disease of the patients.
get:
parameters:
- $ref: '#/components/parameters/DiseaseParam'
responses:
200:
description: Successful Query.
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessfulResponse'
400:
description: The server cannot process the request due to a client error.
404:
description: Requested resource not found.
components:
schemas:
SuccessfulResponse:
type: array
items:
properties:
onsetDate:
description: Date of onset (formatted as YYYY-MM-DD)
type: string
format: date
example: 2020-02-21
endDate:
description: Date of the end of the timeframe
(formatted as YYYY-MM-DD)
type: string
format: date
example: 2020-02-21
parameters:
DiseaseParam:
in: path
description: ID of the disease as it appears on the endpoint.
name: diseaseID
required: true
schema:
type: string
example: ORPHA:589
style: simple
explode: true