-
Notifications
You must be signed in to change notification settings - Fork 5
/
epidemiology_exchange.xsd
404 lines (403 loc) · 18.7 KB
/
epidemiology_exchange.xsd
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
<?xml version="1.0" encoding="UTF-8"?>
<!-- edited with XMLSpy v2020 sp1 (x64) (http://www.altova.com) by H Rodda (None) -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning" xmlns:epi="https://github.com/Co-Epi" targetNamespace="https://github.com/Co-Epi" elementFormDefault="qualified" attributeFormDefault="unqualified" vc:minVersion="1.1">
<xs:element name="Payload">
<xs:annotation>
<xs:documentation>The root element for all communication payloads</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="SystemConfiguration" minOccurs="0">
<xs:annotation>
<xs:documentation>Information regarding system configuration, typically pushed from cloud to client.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="TransmissibleDisease" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="DiseaseName" type="xs:string" use="required"/>
<xs:attribute name="MinimumIncubationPeriod" type="xs:dayTimeDuration">
<xs:annotation>
<xs:documentation>The minimum number of days between infectious exposure and onset of clinical symptoms</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="MaximumIncubationPeriod" type="xs:dayTimeDuration">
<xs:annotation>
<xs:documentation>The sensible maximum (eg. 2 standard deviation) number days between infectious exposure and onset of clinical symptoms</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="HealthRegion" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Configuration to allow display and linking to trusted health information for a specific geographic region</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="RegionCountry" use="required">
<xs:annotation>
<xs:documentation>ISO Country code for the configured region</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RegionState" use="required">
<xs:annotation>
<xs:documentation>Code for the state being configured</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="PublicPhoneNumber" type="xs:string">
<xs:annotation>
<xs:documentation>Phone number to be called by members of the public who have enquiries around COVID-19</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="PublicWebsiteURL" type="xs:anyURI">
<xs:annotation>
<xs:documentation>Link to the main entry point for the public facing information by the local health department</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="PublicWebsiteName" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the main entry point website</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:all>
<xs:attribute name="RetainDataPeriod" type="xs:positiveInteger" default="14">
<xs:annotation>
<xs:documentation>Number of days to retain sensitive data before automated purging</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="MinimumGeoHashResolution" default="5">
<xs:annotation>
<xs:documentation>The minimum allowed geohash resolution fer subscriptions and exposures</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:positiveInteger">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="8"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="CoEpiURL" type="xs:anyURI">
<xs:annotation>
<xs:documentation>Link to the master homepage for CoEpi</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="WorldHealthOrganisationURL">
<xs:annotation>
<xs:documentation>Link to the main entry point for the public facing information by the WHO</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="ExposureCheck" minOccurs="0">
<xs:annotation>
<xs:documentation>A request to retrieve new exposure alerts which have been uploaded since the last check; encompassing a particular set of location combinations</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PartialContactEventUUIDs" type="xs:base64Binary" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A subset of the Contact Event UUIDs that are randomly assigned to one BLE contact event between two compatiple client phones. Half or Quarter length (64 or 32 bit) may be supported.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GeoHash" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A geohash area to limit the check - only BLE contacts that occurred in a listed GeoHash will be returned. Client's decision how precise to request - from minimum precision up to precision 5</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="LastCheckTimeStamp" type="xs:dateTimeStamp" use="required">
<xs:annotation>
<xs:documentation>The date & time of the last successful check - to allow the server to only retrieve new exposure records since that time, and prevent clients from needing to re-process data</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RequestNumber" type="xs:int" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="PossibleExposure" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="Response">
<xs:annotation>
<xs:documentation>Response from server regarding a subscription request</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice>
<xs:element name="Success">
<xs:annotation>
<xs:documentation>The request to subscribe to alerts was successful. Future calls will retrieve relevant Exposure Records automatically.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Suppress">
<xs:annotation>
<xs:documentation>The incidence of disease in a community is so low, that the system is being temporarily disabled - to save client and server resources</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Until" type="xs:dateTime" use="required">
<xs:annotation>
<xs:documentation>Attempt to resume submitting data on this date. If a successful subscription is then sent, client data capture should recommence.
If a new epidemic commences, a push notification can be sent to wake dormant client devices.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="Failure">
<xs:annotation>
<xs:documentation>The subscription request was denied or did not succeed.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="Reason" type="xs:string">
<xs:annotation>
<xs:documentation>Common reasons may include: geographical distribution not consistent with one person's movement. Excessive subscriptions requested. Time period too broad or too far in the past. GeoHash resolution not respected</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="MatchingContactEventUUIDs" type="xs:base64Binary" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>All Full length Contact Event UUIDs that are matched the conditions in the Exposure Check - if any qualified</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="CaseRecord" type="epi:CaseRecordType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A case record representing a person's illness</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ExposureRecord" type="epi:ExposureRecordType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A record of potential exposure with another user</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ConfirmedExposure" minOccurs="0">
<xs:annotation>
<xs:documentation>A notification of confirmed overlapping exposure and proximity information</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="OverlapRecord">
<xs:annotation>
<xs:documentation>A period of time in which two users were in proximity to each other, based on bluetooth data</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="epi:ClinicalSeverity" minOccurs="0"/>
<xs:element name="MatchingProximityData" minOccurs="0">
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element ref="epi:BluetoothProximity"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="CaseClientID" use="required"/>
<xs:attribute name="CaseArrive"/>
<xs:attribute name="CaseDepart"/>
<xs:attribute name="UserArrive"/>
<xs:attribute name="UserDepart"/>
<xs:attribute name="TimeInProximity" type="xs:dayTimeDuration" use="required">
<xs:annotation>
<xs:documentation>Amount of time in minutes that the two users are estimated to have been in proximity to each other</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="TimeInCloseProximity">
<xs:annotation>
<xs:documentation>Estimated time the two people were in close proimity (suggested to be less than 5 metres)</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RequestCaseRecord" type="xs:boolean">
<xs:annotation>
<xs:documentation>If the client wants the case records sent, set to true</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="ScreeningRequest" minOccurs="0">
<xs:annotation>
<xs:documentation>A request for the user to undergo diagnostic testing</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ScreeningResult" minOccurs="0">
<xs:annotation>
<xs:documentation>A result for previously requested diagnostic testing</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute name="ClientID" type="xs:base64Binary" use="required">
<xs:annotation>
<xs:documentation>The globally unique but otherwise anonymous identifier for the client</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="SchemaVersion" type="xs:double" default="0.1"/>
<xs:attribute name="MinimumSupportedVersion" type="xs:double"/>
</xs:complexType>
</xs:element>
<xs:element name="PotentialExposure">
<xs:annotation>
<xs:documentation>A notification of potentially relevant exposure profiles</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BluetoothProximity">
<xs:annotation>
<xs:documentation>A data point representing the proximity of two bluetooth devices</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="SignalStrength"/>
<xs:attribute name="BluetoothUUIDHash" use="required"/>
<xs:attribute name="ContactTime" type="xs:dateTime" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="ClinicalSeverity">
<xs:annotation>
<xs:documentation>An estimation of case severity provided by the user</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice>
<xs:element name="MinimalSymptoms"/>
<xs:element name="MildSymptoms"/>
<xs:element name="ModerateSymptoms"/>
<xs:element name="SevereSymptoms"/>
</xs:choice>
<xs:attribute name="IsHospitalised" type="xs:boolean"/>
</xs:complexType>
</xs:element>
<xs:complexType name="ApproximateLocationAndTimeType">
<xs:annotation>
<xs:documentation>A data point representing an appoximate location and a time band, thus providing a physical presence window</xs:documentation>
</xs:annotation>
<xs:attribute name="StartTimeBand" type="xs:dateTime" use="required">
<xs:annotation>
<xs:documentation>The date/time that the user was in the geoHash region - by default, a 1 hour band if endTimeBand is not provided</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="GeoHash" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>A geographical region denoted by a geohash value. Recommended resolution is 5 character (approx. 5km box)</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="EndTimeBand" type="xs:dateTime" use="optional"/>
</xs:complexType>
<xs:element name="ApproximateLocationAndTime" type="epi:ApproximateLocationAndTimeType"/>
<xs:complexType name="ProximityRecordType">
<xs:sequence>
<xs:element ref="epi:ApproximateLocationAndTime"/>
<xs:element ref="epi:BluetoothProximity"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ExposureRecordType">
<xs:sequence maxOccurs="unbounded">
<xs:element name="ProximityRecord" type="epi:ProximityRecordType">
<xs:annotation>
<xs:documentation>A record representing a time band, appoximate location, and a set of bluetooth identiifers seen in that period</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="OtherClientID" use="required">
<xs:annotation>
<xs:documentation>The other user's anonymous client ID</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="CaseRecordType">
<xs:sequence maxOccurs="unbounded">
<xs:element name="HealthQuiz">
<xs:complexType>
<xs:sequence>
<xs:element name="ClinicalSymptoms">
<xs:annotation>
<xs:documentation>A list of active symptoms as reported by the user</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Fever" minOccurs="0">
<xs:annotation>
<xs:documentation>measured temperature over 38.0 deg C / 100.4 deg F</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Cough" minOccurs="0">
<xs:complexType>
<xs:choice>
<xs:element name="Infrequent">
<xs:annotation>
<xs:documentation>less than 10 times a day</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Regular">
<xs:annotation>
<xs:documentation>up to 5 times an hour</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Intractable">
<xs:annotation>
<xs:documentation>more than 5 times an hour</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="ShortnessOfBreath" minOccurs="0"/>
<xs:element name="NasalCongestion" minOccurs="0"/>
<xs:element name="SoreThroat" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ClinicalSigns" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of clinical observations as captured by integrated health devices</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Temperature" minOccurs="0">
<xs:complexType>
<xs:attribute name="ObservationTime" type="xs:dateTime" use="required"/>
<xs:attribute name="MeasuredTemperature" type="xs:double" use="required"/>
<xs:attribute name="IsDegCelcius" type="xs:boolean" use="required">
<xs:annotation>
<xs:documentation>true = celcius; false = farenheit</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="OxygenSaturation" minOccurs="0">
<xs:complexType>
<xs:attribute name="spO2" type="xs:double"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="epi:ClinicalSeverity" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="QuizTime" type="xs:dateTime">
<xs:annotation>
<xs:documentation>The date/time the quiz was completed</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="CaseID" type="xs:positiveInteger" use="required">
<xs:annotation>
<xs:documentation>An identifier given to the case by the client. likely to be an integer index of case records</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="SymptomOnsetTime" type="xs:dateTime" use="required">
<xs:annotation>
<xs:documentation>reported date/time of first symptom onset</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="LikelyExposureTime">
<xs:annotation>
<xs:documentation>calculated date/time of infectious exposure, based on most likely transmission chain, if determined</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:schema>