@azure-rest/health-insights-clinicalmatching 1.0.0-alpha.20241126.1 → 1.0.0-alpha.20241127.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@azure-rest/health-insights-clinicalmatching",
|
|
3
3
|
"sdk-type": "client",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
|
-
"version": "1.0.0-alpha.
|
|
5
|
+
"version": "1.0.0-alpha.20241127.1",
|
|
6
6
|
"description": "A generated SDK for Health Insights Clinical Matching Rest",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"node",
|
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
"@azure/abort-controller": "^2.1.2",
|
|
63
63
|
"@azure/core-auth": "^1.9.0",
|
|
64
64
|
"@azure/core-lro": "^2.7.2",
|
|
65
|
-
"@azure/core-rest-pipeline": "
|
|
65
|
+
"@azure/core-rest-pipeline": "^1.18.0",
|
|
66
66
|
"@azure/logger": "^1.1.4",
|
|
67
67
|
"tslib": "^2.8.1"
|
|
68
68
|
},
|
|
@@ -1,650 +0,0 @@
|
|
|
1
|
-
import type { Client } from '@azure-rest/core-client';
|
|
2
|
-
import type { ClientOptions } from '@azure-rest/core-client';
|
|
3
|
-
import type { CreateHttpPollerOptions } from '@azure/core-lro';
|
|
4
|
-
import type { ErrorResponse } from '@azure-rest/core-client';
|
|
5
|
-
import type { HttpResponse } from '@azure-rest/core-client';
|
|
6
|
-
import type { KeyCredential } from '@azure/core-auth';
|
|
7
|
-
import type { OperationState } from '@azure/core-lro';
|
|
8
|
-
import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
|
|
9
|
-
import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
|
|
10
|
-
import type { RequestParameters } from '@azure-rest/core-client';
|
|
11
|
-
import type { SimplePollerLike } from '@azure/core-lro';
|
|
12
|
-
import type { StreamableMethod } from '@azure-rest/core-client';
|
|
13
|
-
|
|
14
|
-
/** A person's age, given as a number (value) and a unit (e.g. years, months) */
|
|
15
|
-
export declare interface AcceptedAge {
|
|
16
|
-
/**
|
|
17
|
-
* Possible units for a person's age.
|
|
18
|
-
*
|
|
19
|
-
* Possible values: years, months, days
|
|
20
|
-
*/
|
|
21
|
-
unit: string;
|
|
22
|
-
/** The number of years/months/days that represents the person's age. */
|
|
23
|
-
value: number;
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/** A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age. */
|
|
27
|
-
export declare interface AcceptedAgeRange {
|
|
28
|
-
/** A person's age, given as a number (value) and a unit (e.g. years, months) */
|
|
29
|
-
minimumAge?: AcceptedAge;
|
|
30
|
-
/** A person's age, given as a number (value) and a unit (e.g. years, months) */
|
|
31
|
-
maximumAge?: AcceptedAge;
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
/** `GeoJSON` geometry, representing the area circle's center. */
|
|
35
|
-
export declare interface AreaGeometry {
|
|
36
|
-
/**
|
|
37
|
-
* `GeoJSON` geometry type.
|
|
38
|
-
*
|
|
39
|
-
* Possible values: Point
|
|
40
|
-
*/
|
|
41
|
-
type: string;
|
|
42
|
-
/**
|
|
43
|
-
* Coordinates of the area circle's center, represented according to the `GeoJSON` standard.
|
|
44
|
-
* This is an array of 2 decimal numbers, longitude and latitude (precisely in this order).
|
|
45
|
-
*/
|
|
46
|
-
coordinates: number[];
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
/** `GeoJSON` object properties. */
|
|
50
|
-
export declare interface AreaProperties {
|
|
51
|
-
/**
|
|
52
|
-
* `GeoJSON` object sub-type.
|
|
53
|
-
*
|
|
54
|
-
* Possible values: Circle
|
|
55
|
-
*/
|
|
56
|
-
subType: string;
|
|
57
|
-
/** The radius of the area's circle, in meters. */
|
|
58
|
-
radius: number;
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/** A piece of clinical information, expressed as a code in a clinical coding system. */
|
|
62
|
-
export declare interface ClinicalCodedElement {
|
|
63
|
-
/** The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. */
|
|
64
|
-
system: string;
|
|
65
|
-
/** The code within the given clinical coding system. */
|
|
66
|
-
code: string;
|
|
67
|
-
/** The name of this coded concept in the coding system. */
|
|
68
|
-
name?: string;
|
|
69
|
-
/** A value associated with the code within the given clinical coding system. */
|
|
70
|
-
value?: string;
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
/** A piece of clinical information, expressed as a code in a clinical coding system. */
|
|
74
|
-
export declare interface ClinicalCodedElementOutput {
|
|
75
|
-
/** The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. */
|
|
76
|
-
system: string;
|
|
77
|
-
/** The code within the given clinical coding system. */
|
|
78
|
-
code: string;
|
|
79
|
-
/** The name of this coded concept in the coding system. */
|
|
80
|
-
name?: string;
|
|
81
|
-
/** A value associated with the code within the given clinical coding system. */
|
|
82
|
-
value?: string;
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
export declare type ClinicalMatchingRestClient = Client & {
|
|
86
|
-
path: Routes;
|
|
87
|
-
};
|
|
88
|
-
|
|
89
|
-
/** A piece of evidence from a clinical note (text document). */
|
|
90
|
-
export declare interface ClinicalNoteEvidenceOutput {
|
|
91
|
-
/** The identifier of the document containing the evidence. */
|
|
92
|
-
id: string;
|
|
93
|
-
/** The actual text span which is evidence for the inference. */
|
|
94
|
-
text?: string;
|
|
95
|
-
/** The start index of the evidence text span in the document (0 based). */
|
|
96
|
-
offset: number;
|
|
97
|
-
/** The length of the evidence text span. */
|
|
98
|
-
length: number;
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
/** Demographic criteria for a clinical trial. */
|
|
102
|
-
export declare interface ClinicalTrialDemographics {
|
|
103
|
-
/**
|
|
104
|
-
* Indication of the sex of people who may participate in the clinical trial.
|
|
105
|
-
*
|
|
106
|
-
* Possible values: all, female, male
|
|
107
|
-
*/
|
|
108
|
-
acceptedSex?: string;
|
|
109
|
-
/** A definition of the range of ages accepted by a clinical trial. Contains a minimum age and/or a maximum age. */
|
|
110
|
-
acceptedAgeRange?: AcceptedAgeRange;
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
/** A description of a clinical trial. */
|
|
114
|
-
export declare interface ClinicalTrialDetails {
|
|
115
|
-
/** A given identifier for the clinical trial. Has to be unique within a list of clinical trials. */
|
|
116
|
-
id: string;
|
|
117
|
-
/** The eligibility criteria of the clinical trial (inclusion and exclusion), given as text. */
|
|
118
|
-
eligibilityCriteriaText?: string;
|
|
119
|
-
/** Demographic criteria for a clinical trial. */
|
|
120
|
-
demographics?: ClinicalTrialDemographics;
|
|
121
|
-
/** Trial data which is of interest to the potential participant. */
|
|
122
|
-
metadata: ClinicalTrialMetadata;
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
/** Trial data which is of interest to the potential participant. */
|
|
126
|
-
export declare interface ClinicalTrialMetadata {
|
|
127
|
-
/**
|
|
128
|
-
* Phases which are relevant for the clinical trial.
|
|
129
|
-
* Each clinical trial can be in a certain phase or in multiple phases.
|
|
130
|
-
*/
|
|
131
|
-
phases?: string[];
|
|
132
|
-
/**
|
|
133
|
-
* Possible study types of a clinical trial.
|
|
134
|
-
*
|
|
135
|
-
* Possible values: interventional, observational, expandedAccess, patientRegistries
|
|
136
|
-
*/
|
|
137
|
-
studyType?: string;
|
|
138
|
-
/**
|
|
139
|
-
* Possible recruitment status of a clinical trial.
|
|
140
|
-
*
|
|
141
|
-
* Possible values: unknownStatus, notYetRecruiting, recruiting, enrollingByInvitation
|
|
142
|
-
*/
|
|
143
|
-
recruitmentStatus?: string;
|
|
144
|
-
/** Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. */
|
|
145
|
-
conditions: string[];
|
|
146
|
-
/** Sponsors/collaborators involved with the trial. */
|
|
147
|
-
sponsors?: string[];
|
|
148
|
-
/** Contact details of the trial administrators, for patients that want to participate in the trial. */
|
|
149
|
-
contacts?: Array<ContactDetails>;
|
|
150
|
-
/** Research facilities where the clinical trial is conducted. */
|
|
151
|
-
facilities?: Array<ClinicalTrialResearchFacility>;
|
|
152
|
-
}
|
|
153
|
-
|
|
154
|
-
/** Trial data which is of interest to the potential participant. */
|
|
155
|
-
export declare interface ClinicalTrialMetadataOutput {
|
|
156
|
-
/**
|
|
157
|
-
* Phases which are relevant for the clinical trial.
|
|
158
|
-
* Each clinical trial can be in a certain phase or in multiple phases.
|
|
159
|
-
*/
|
|
160
|
-
phases?: string[];
|
|
161
|
-
/**
|
|
162
|
-
* Possible study types of a clinical trial.
|
|
163
|
-
*
|
|
164
|
-
* Possible values: interventional, observational, expandedAccess, patientRegistries
|
|
165
|
-
*/
|
|
166
|
-
studyType?: string;
|
|
167
|
-
/**
|
|
168
|
-
* Possible recruitment status of a clinical trial.
|
|
169
|
-
*
|
|
170
|
-
* Possible values: unknownStatus, notYetRecruiting, recruiting, enrollingByInvitation
|
|
171
|
-
*/
|
|
172
|
-
recruitmentStatus?: string;
|
|
173
|
-
/** Medical conditions and their synonyms which are relevant for the clinical trial, given as strings. */
|
|
174
|
-
conditions: string[];
|
|
175
|
-
/** Sponsors/collaborators involved with the trial. */
|
|
176
|
-
sponsors?: string[];
|
|
177
|
-
/** Contact details of the trial administrators, for patients that want to participate in the trial. */
|
|
178
|
-
contacts?: Array<ContactDetailsOutput>;
|
|
179
|
-
/** Research facilities where the clinical trial is conducted. */
|
|
180
|
-
facilities?: Array<ClinicalTrialResearchFacilityOutput>;
|
|
181
|
-
}
|
|
182
|
-
|
|
183
|
-
/** A filter defining a subset of clinical trials from a given clinical trial registry (e.g. clinicaltrials.gov). */
|
|
184
|
-
export declare interface ClinicalTrialRegistryFilter {
|
|
185
|
-
/**
|
|
186
|
-
* Trials with any of the given medical conditions will be included in the selection (provided that other limitations are satisfied).
|
|
187
|
-
* Leaving this list empty will not limit the medical conditions.
|
|
188
|
-
*/
|
|
189
|
-
conditions?: string[];
|
|
190
|
-
/**
|
|
191
|
-
* Trials with any of the given study types will be included in the selection (provided that other limitations are satisfied).
|
|
192
|
-
* Leaving this list empty will not limit the study types.
|
|
193
|
-
*/
|
|
194
|
-
studyTypes?: string[];
|
|
195
|
-
/**
|
|
196
|
-
* Trials with any of the given recruitment statuses will be included in the selection (provided that other limitations are satisfied).
|
|
197
|
-
* Leaving this list empty will not limit the recruitment statuses.
|
|
198
|
-
*/
|
|
199
|
-
recruitmentStatuses?: string[];
|
|
200
|
-
/**
|
|
201
|
-
* Trials with any of the given sponsors will be included in the selection (provided that other limitations are satisfied).
|
|
202
|
-
* Leaving this list empty will not limit the sponsors.
|
|
203
|
-
*/
|
|
204
|
-
sponsors?: string[];
|
|
205
|
-
/**
|
|
206
|
-
* Trials with any of the given phases will be included in the selection (provided that other limitations are satisfied).
|
|
207
|
-
* Leaving this list empty will not limit the phases.
|
|
208
|
-
*/
|
|
209
|
-
phases?: string[];
|
|
210
|
-
/**
|
|
211
|
-
* Trials with any of the given purposes will be included in the selection (provided that other limitations are satisfied).
|
|
212
|
-
* Leaving this list empty will not limit the purposes.
|
|
213
|
-
*/
|
|
214
|
-
purposes?: string[];
|
|
215
|
-
/**
|
|
216
|
-
* Trials with any of the given identifiers will be included in the selection (provided that other limitations are satisfied).
|
|
217
|
-
* Leaving this list empty will not limit the trial identifiers.
|
|
218
|
-
*/
|
|
219
|
-
ids?: string[];
|
|
220
|
-
/**
|
|
221
|
-
* Trials with any of the given sources will be included in the selection (provided that other limitations are satisfied).
|
|
222
|
-
* Leaving this list empty will not limit the sources.
|
|
223
|
-
*/
|
|
224
|
-
sources?: string[];
|
|
225
|
-
/**
|
|
226
|
-
* Trials with any of the given facility names will be included in the selection (provided that other limitations are satisfied).
|
|
227
|
-
* Leaving this list empty will not limit the trial facility names.
|
|
228
|
-
*/
|
|
229
|
-
facilityNames?: string[];
|
|
230
|
-
/**
|
|
231
|
-
* Trials with any of the given facility locations will be included in the selection (provided that other limitations are satisfied).
|
|
232
|
-
* Leaving this list empty will not limit the trial facility locations.
|
|
233
|
-
*/
|
|
234
|
-
facilityLocations?: Array<GeographicLocation>;
|
|
235
|
-
/**
|
|
236
|
-
* Trials with any of the given facility area boundaries will be included in the selection (provided that other limitations are satisfied).
|
|
237
|
-
* Leaving this list empty will not limit the trial facility area boundaries.
|
|
238
|
-
*/
|
|
239
|
-
facilityAreas?: Array<GeographicArea>;
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
/** Details of a research facility where a clinical trial is conducted. */
|
|
243
|
-
export declare interface ClinicalTrialResearchFacility {
|
|
244
|
-
/** The facility's name. */
|
|
245
|
-
name: string;
|
|
246
|
-
/** City name. */
|
|
247
|
-
city?: string;
|
|
248
|
-
/** State name. */
|
|
249
|
-
state?: string;
|
|
250
|
-
/** Country/region name. */
|
|
251
|
-
countryOrRegion: string;
|
|
252
|
-
}
|
|
253
|
-
|
|
254
|
-
/** Details of a research facility where a clinical trial is conducted. */
|
|
255
|
-
export declare interface ClinicalTrialResearchFacilityOutput {
|
|
256
|
-
/** The facility's name. */
|
|
257
|
-
name: string;
|
|
258
|
-
/** City name. */
|
|
259
|
-
city?: string;
|
|
260
|
-
/** State name. */
|
|
261
|
-
state?: string;
|
|
262
|
-
/** Country/region name. */
|
|
263
|
-
countryOrRegion: string;
|
|
264
|
-
}
|
|
265
|
-
|
|
266
|
-
/**
|
|
267
|
-
* The clinical trials that the patient(s) should be matched to.
|
|
268
|
-
* The trial selection can be given as a list of custom clinical trials and/or a list of filters to known clinical trial registries.
|
|
269
|
-
* In case both are given, the resulting trial set is a union of the two sets.
|
|
270
|
-
*/
|
|
271
|
-
export declare interface ClinicalTrials {
|
|
272
|
-
/** A list of clinical trials. */
|
|
273
|
-
customTrials?: Array<ClinicalTrialDetails>;
|
|
274
|
-
/**
|
|
275
|
-
* A list of filters, each one creating a selection of trials from a given
|
|
276
|
-
* clinical trial registry.
|
|
277
|
-
*/
|
|
278
|
-
registryFilters?: Array<ClinicalTrialRegistryFilter>;
|
|
279
|
-
}
|
|
280
|
-
|
|
281
|
-
/** A person's contact details. */
|
|
282
|
-
export declare interface ContactDetails {
|
|
283
|
-
/** The person's name. */
|
|
284
|
-
name?: string;
|
|
285
|
-
/** The person's email. */
|
|
286
|
-
email?: string;
|
|
287
|
-
/** A person's phone number. */
|
|
288
|
-
phone?: string;
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
/** A person's contact details. */
|
|
292
|
-
export declare interface ContactDetailsOutput {
|
|
293
|
-
/** The person's name. */
|
|
294
|
-
name?: string;
|
|
295
|
-
/** The person's email. */
|
|
296
|
-
email?: string;
|
|
297
|
-
/** A person's phone number. */
|
|
298
|
-
phone?: string;
|
|
299
|
-
}
|
|
300
|
-
|
|
301
|
-
/**
|
|
302
|
-
* Initialize a new instance of `ClinicalMatchingRestClient`
|
|
303
|
-
* @param endpoint - Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com).
|
|
304
|
-
* @param credentials - uniquely identify client credential
|
|
305
|
-
* @param options - the parameter for all optional parameters
|
|
306
|
-
*/
|
|
307
|
-
declare function createClient(endpoint: string, credentials: KeyCredential, options?: ClientOptions): ClinicalMatchingRestClient;
|
|
308
|
-
export default createClient;
|
|
309
|
-
|
|
310
|
-
export declare interface CreateJob {
|
|
311
|
-
/** Creates a Trial Matcher job with the given request body. */
|
|
312
|
-
post(options?: CreateJobParameters): StreamableMethod<CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse>;
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
/** The request has succeeded. */
|
|
316
|
-
export declare interface CreateJob200Response extends HttpResponse {
|
|
317
|
-
status: "200";
|
|
318
|
-
body: TrialMatcherResultOutput;
|
|
319
|
-
}
|
|
320
|
-
|
|
321
|
-
export declare interface CreateJob202Headers {
|
|
322
|
-
/** The location for monitoring the operation state. */
|
|
323
|
-
"operation-location": string;
|
|
324
|
-
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
325
|
-
"retry-after"?: number;
|
|
326
|
-
/** Indicates whether the repeatable request was accepted or rejected. */
|
|
327
|
-
"repeatability-result"?: "accepted" | "rejected";
|
|
328
|
-
}
|
|
329
|
-
|
|
330
|
-
/** The request has been accepted for processing, but processing has not yet completed. */
|
|
331
|
-
export declare interface CreateJob202Response extends HttpResponse {
|
|
332
|
-
status: "202";
|
|
333
|
-
headers: RawHttpHeaders & CreateJob202Headers;
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
export declare interface CreateJobBodyParam {
|
|
337
|
-
body?: TrialMatcherData;
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
export declare interface CreateJobDefaultHeaders {
|
|
341
|
-
/** String error code indicating what went wrong. */
|
|
342
|
-
"x-ms-error-code"?: string;
|
|
343
|
-
}
|
|
344
|
-
|
|
345
|
-
export declare interface CreateJobDefaultResponse extends HttpResponse {
|
|
346
|
-
status: string;
|
|
347
|
-
body: ErrorResponse;
|
|
348
|
-
headers: RawHttpHeaders & CreateJobDefaultHeaders;
|
|
349
|
-
}
|
|
350
|
-
|
|
351
|
-
export declare interface CreateJobHeaderParam {
|
|
352
|
-
headers?: RawHttpHeadersInput & CreateJobHeaders;
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
export declare interface CreateJobHeaders {
|
|
356
|
-
/** An opaque, globally-unique, client-generated string identifier for the request. */
|
|
357
|
-
"Repeatability-Request-ID"?: string;
|
|
358
|
-
/** Specifies the date and time at which the request was first created. */
|
|
359
|
-
"Repeatability-First-Sent"?: string;
|
|
360
|
-
}
|
|
361
|
-
|
|
362
|
-
/** The final response for long-running createJob operation */
|
|
363
|
-
export declare interface CreateJobLogicalResponse extends HttpResponse {
|
|
364
|
-
status: "200";
|
|
365
|
-
body: TrialMatcherResultOutput;
|
|
366
|
-
}
|
|
367
|
-
|
|
368
|
-
export declare type CreateJobParameters = CreateJobHeaderParam & CreateJobBodyParam & RequestParameters;
|
|
369
|
-
|
|
370
|
-
/** The content of the patient document. */
|
|
371
|
-
export declare interface DocumentContent {
|
|
372
|
-
/**
|
|
373
|
-
* The type of the content's source.
|
|
374
|
-
* In case the source type is 'inline', the content is given as a string (for instance, text).
|
|
375
|
-
* In case the source type is 'reference', the content is given as a URI.
|
|
376
|
-
*
|
|
377
|
-
* Possible values: inline, reference
|
|
378
|
-
*/
|
|
379
|
-
sourceType: string;
|
|
380
|
-
/** The content of the document, given either inline (as a string) or as a reference (URI). */
|
|
381
|
-
value: string;
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
/** The error object. */
|
|
385
|
-
export declare interface ErrorModelOutput {
|
|
386
|
-
/** One of a server-defined set of error codes. */
|
|
387
|
-
code: string;
|
|
388
|
-
/** A human-readable representation of the error. */
|
|
389
|
-
message: string;
|
|
390
|
-
/** The target of the error. */
|
|
391
|
-
target?: string;
|
|
392
|
-
/** An array of details about specific errors that led to this reported error. */
|
|
393
|
-
details?: Array<ErrorModelOutput>;
|
|
394
|
-
/** An object containing more specific information than the current object about the error. */
|
|
395
|
-
innererror?: InnerErrorOutput;
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
/** A piece of clinical information, expressed as a code in a clinical coding system, extended by semantic information. */
|
|
399
|
-
export declare interface ExtendedClinicalCodedElementOutput {
|
|
400
|
-
/** The clinical coding system, e.g. ICD-10, SNOMED-CT, UMLS. */
|
|
401
|
-
system: string;
|
|
402
|
-
/** The code within the given clinical coding system. */
|
|
403
|
-
code: string;
|
|
404
|
-
/** The name of this coded concept in the coding system. */
|
|
405
|
-
name?: string;
|
|
406
|
-
/** A value associated with the code within the given clinical coding system. */
|
|
407
|
-
value?: string;
|
|
408
|
-
/** The [UMLS semantic type](https://www.nlm.nih.gov/research/umls/META3_current_semantic_types.html) associated with the coded concept. */
|
|
409
|
-
semanticType?: string;
|
|
410
|
-
/** The bio-medical category related to the coded concept, e.g. Diagnosis, Symptom, Medication, Examination. */
|
|
411
|
-
category?: string;
|
|
412
|
-
}
|
|
413
|
-
|
|
414
|
-
/** A geographic area, expressed as a `Circle` geometry represented using a `GeoJSON Feature` (see [GeoJSON spec](https://tools.ietf.org/html/rfc7946)). */
|
|
415
|
-
export declare interface GeographicArea {
|
|
416
|
-
/**
|
|
417
|
-
* `GeoJSON` type.
|
|
418
|
-
*
|
|
419
|
-
* Possible values: Feature
|
|
420
|
-
*/
|
|
421
|
-
type: string;
|
|
422
|
-
/** `GeoJSON` geometry, representing the area circle's center. */
|
|
423
|
-
geometry: AreaGeometry;
|
|
424
|
-
/** `GeoJSON` object properties. */
|
|
425
|
-
properties: AreaProperties;
|
|
426
|
-
}
|
|
427
|
-
|
|
428
|
-
/**
|
|
429
|
-
* A location given as a combination of city, state and country/region. It could specify a city, a state or a country/region.
|
|
430
|
-
* In case a city is specified, either state +country/region or country/region (for countries/regions where there are no states) should be added.
|
|
431
|
-
* In case a state is specified (without a city), country/region should be added.
|
|
432
|
-
*/
|
|
433
|
-
export declare interface GeographicLocation {
|
|
434
|
-
/** City name. */
|
|
435
|
-
city?: string;
|
|
436
|
-
/** State name. */
|
|
437
|
-
state?: string;
|
|
438
|
-
/** Country/region name. */
|
|
439
|
-
countryOrRegion: string;
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
export declare interface GetJob {
|
|
443
|
-
/** Gets the status and details of the Trial Matcher job. */
|
|
444
|
-
get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
/** The request has succeeded. */
|
|
448
|
-
export declare interface GetJob200Response extends HttpResponse {
|
|
449
|
-
status: "200";
|
|
450
|
-
body: TrialMatcherResultOutput;
|
|
451
|
-
}
|
|
452
|
-
|
|
453
|
-
export declare interface GetJobDefaultHeaders {
|
|
454
|
-
/** String error code indicating what went wrong. */
|
|
455
|
-
"x-ms-error-code"?: string;
|
|
456
|
-
}
|
|
457
|
-
|
|
458
|
-
export declare interface GetJobDefaultResponse extends HttpResponse {
|
|
459
|
-
status: string;
|
|
460
|
-
body: ErrorResponse;
|
|
461
|
-
headers: RawHttpHeaders & GetJobDefaultHeaders;
|
|
462
|
-
}
|
|
463
|
-
|
|
464
|
-
export declare type GetJobParameters = RequestParameters;
|
|
465
|
-
|
|
466
|
-
/**
|
|
467
|
-
* Helper function that builds a Poller object to help polling a long running operation.
|
|
468
|
-
* @param client - Client to use for sending the request to get additional pages.
|
|
469
|
-
* @param initialResponse - The initial response.
|
|
470
|
-
* @param options - Options to set a resume state or custom polling interval.
|
|
471
|
-
* @returns - A poller object to poll for operation state updates and eventually get the final response.
|
|
472
|
-
*/
|
|
473
|
-
export declare function getLongRunningPoller<TResult extends CreateJobLogicalResponse | CreateJobDefaultResponse>(client: Client, initialResponse: CreateJob200Response | CreateJob202Response | CreateJobDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
474
|
-
|
|
475
|
-
/** An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. */
|
|
476
|
-
export declare interface InnerErrorOutput {
|
|
477
|
-
/** One of a server-defined set of error codes. */
|
|
478
|
-
code?: string;
|
|
479
|
-
/** Inner error. */
|
|
480
|
-
innererror?: InnerErrorOutput;
|
|
481
|
-
}
|
|
482
|
-
|
|
483
|
-
export declare function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
|
|
484
|
-
|
|
485
|
-
export declare function isUnexpected(response: CreateJob200Response | CreateJob202Response | CreateJobLogicalResponse | CreateJobDefaultResponse): response is CreateJobDefaultResponse;
|
|
486
|
-
|
|
487
|
-
/** A clinical document related to a patient. Document here is in the wide sense - not just a text document (note). */
|
|
488
|
-
export declare interface PatientDocument {
|
|
489
|
-
/**
|
|
490
|
-
* The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).
|
|
491
|
-
*
|
|
492
|
-
* Possible values: note, fhirBundle, dicom, genomicSequencing
|
|
493
|
-
*/
|
|
494
|
-
type: string;
|
|
495
|
-
/**
|
|
496
|
-
* The type of the clinical document.
|
|
497
|
-
*
|
|
498
|
-
* Possible values: consultation, dischargeSummary, historyAndPhysical, procedure, progress, imaging, laboratory, pathology
|
|
499
|
-
*/
|
|
500
|
-
clinicalType?: string;
|
|
501
|
-
/** A given identifier for the document. Has to be unique across all documents for a single patient. */
|
|
502
|
-
id: string;
|
|
503
|
-
/** A 2 letter ISO 639-1 representation of the language of the document. */
|
|
504
|
-
language?: string;
|
|
505
|
-
/** The date and time when the document was created. */
|
|
506
|
-
createdDateTime?: Date | string;
|
|
507
|
-
/** The content of the patient document. */
|
|
508
|
-
content: DocumentContent;
|
|
509
|
-
}
|
|
510
|
-
|
|
511
|
-
/** Patient structured information, including demographics and known structured clinical information. */
|
|
512
|
-
export declare interface PatientInfo {
|
|
513
|
-
/**
|
|
514
|
-
* The patient's sex.
|
|
515
|
-
*
|
|
516
|
-
* Possible values: female, male, unspecified
|
|
517
|
-
*/
|
|
518
|
-
sex?: string;
|
|
519
|
-
/** The patient's date of birth. */
|
|
520
|
-
birthDate?: Date | string;
|
|
521
|
-
/** Known clinical information for the patient, structured. */
|
|
522
|
-
clinicalInfo?: Array<ClinicalCodedElement>;
|
|
523
|
-
}
|
|
524
|
-
|
|
525
|
-
/** A patient record, including their clinical information and data. */
|
|
526
|
-
export declare interface PatientRecord {
|
|
527
|
-
/** A given identifier for the patient. Has to be unique across all patients in a single request. */
|
|
528
|
-
id: string;
|
|
529
|
-
/** Patient structured information, including demographics and known structured clinical information. */
|
|
530
|
-
info?: PatientInfo;
|
|
531
|
-
/** Patient unstructured clinical data, given as documents. */
|
|
532
|
-
data?: Array<PatientDocument>;
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
export declare interface Routes {
|
|
536
|
-
/** Resource for '/trialmatcher/jobs/\{jobId\}' has methods for the following verbs: get */
|
|
537
|
-
(path: "/trialmatcher/jobs/{jobId}", jobId: string): GetJob;
|
|
538
|
-
/** Resource for '/trialmatcher/jobs' has methods for the following verbs: post */
|
|
539
|
-
(path: "/trialmatcher/jobs"): CreateJob;
|
|
540
|
-
}
|
|
541
|
-
|
|
542
|
-
/** The body of the Trial Matcher request. */
|
|
543
|
-
export declare interface TrialMatcherData {
|
|
544
|
-
/** The list of patients, including their clinical information and data. */
|
|
545
|
-
patients: Array<PatientRecord>;
|
|
546
|
-
/** Configuration affecting the Trial Matcher model's inference. */
|
|
547
|
-
configuration?: TrialMatcherModelConfiguration;
|
|
548
|
-
}
|
|
549
|
-
|
|
550
|
-
/** A piece of evidence corresponding to a Trial Matcher inference. */
|
|
551
|
-
export declare interface TrialMatcherInferenceEvidenceOutput {
|
|
552
|
-
/** A piece of evidence from the eligibility criteria text of a clinical trial. */
|
|
553
|
-
eligibilityCriteriaEvidence?: string;
|
|
554
|
-
/** A piece of evidence from a clinical note (text document). */
|
|
555
|
-
patientDataEvidence?: ClinicalNoteEvidenceOutput;
|
|
556
|
-
/**
|
|
557
|
-
* A piece of clinical information, expressed as a code in a clinical coding
|
|
558
|
-
* system.
|
|
559
|
-
*/
|
|
560
|
-
patientInfoEvidence?: ClinicalCodedElementOutput;
|
|
561
|
-
/** A value indicating how important this piece of evidence is for the inference. */
|
|
562
|
-
importance?: number;
|
|
563
|
-
}
|
|
564
|
-
|
|
565
|
-
/** An inference made by the Trial Matcher model regarding a patient. */
|
|
566
|
-
export declare interface TrialMatcherInferenceOutput {
|
|
567
|
-
/**
|
|
568
|
-
* The type of the Trial Matcher inference.
|
|
569
|
-
*
|
|
570
|
-
* Possible values: trialEligibility
|
|
571
|
-
*/
|
|
572
|
-
type: string;
|
|
573
|
-
/** The value of the inference, as relevant for the given inference type. */
|
|
574
|
-
value: string;
|
|
575
|
-
/** The description corresponding to the inference value. */
|
|
576
|
-
description?: string;
|
|
577
|
-
/** Confidence score for this inference. */
|
|
578
|
-
confidenceScore?: number;
|
|
579
|
-
/** The evidence corresponding to the inference value. */
|
|
580
|
-
evidence?: Array<TrialMatcherInferenceEvidenceOutput>;
|
|
581
|
-
/** The identifier of the clinical trial. */
|
|
582
|
-
id?: string;
|
|
583
|
-
/**
|
|
584
|
-
* Possible sources of a clinical trial.
|
|
585
|
-
*
|
|
586
|
-
* Possible values: custom, clinicaltrials.gov
|
|
587
|
-
*/
|
|
588
|
-
source?: string;
|
|
589
|
-
/** Trial data which is of interest to the potential participant. */
|
|
590
|
-
metadata?: ClinicalTrialMetadataOutput;
|
|
591
|
-
}
|
|
592
|
-
|
|
593
|
-
/** Configuration affecting the Trial Matcher model's inference. */
|
|
594
|
-
export declare interface TrialMatcherModelConfiguration {
|
|
595
|
-
/** An indication whether the model should produce verbose output. */
|
|
596
|
-
verbose?: boolean;
|
|
597
|
-
/** An indication whether the model's output should include evidence for the inferences. */
|
|
598
|
-
includeEvidence?: boolean;
|
|
599
|
-
/**
|
|
600
|
-
* The clinical trials that the patient(s) should be matched to. <br />The trial
|
|
601
|
-
* selection can be given as a list of custom clinical trials and/or a list of
|
|
602
|
-
* filters to known clinical trial registries. In case both are given, the
|
|
603
|
-
* resulting trial set is a union of the two sets.
|
|
604
|
-
*/
|
|
605
|
-
clinicalTrials: ClinicalTrials;
|
|
606
|
-
}
|
|
607
|
-
|
|
608
|
-
/** The results of the model's work for a single patient. */
|
|
609
|
-
export declare interface TrialMatcherPatientResultOutput {
|
|
610
|
-
/** The identifier given for the patient in the request. */
|
|
611
|
-
id: string;
|
|
612
|
-
/** The model's inferences for the given patient. */
|
|
613
|
-
inferences: Array<TrialMatcherInferenceOutput>;
|
|
614
|
-
/** Clinical information which is needed to provide better trial matching results for the patient. */
|
|
615
|
-
neededClinicalInfo?: Array<ExtendedClinicalCodedElementOutput>;
|
|
616
|
-
}
|
|
617
|
-
|
|
618
|
-
/** The response for the Trial Matcher request. */
|
|
619
|
-
export declare interface TrialMatcherResultOutput {
|
|
620
|
-
/** A processing job identifier. */
|
|
621
|
-
readonly jobId: string;
|
|
622
|
-
/** The date and time when the processing job was created. */
|
|
623
|
-
readonly createdDateTime: string;
|
|
624
|
-
/** The date and time when the processing job is set to expire. */
|
|
625
|
-
readonly expirationDateTime: string;
|
|
626
|
-
/** The date and time when the processing job was last updated. */
|
|
627
|
-
readonly lastUpdateDateTime: string;
|
|
628
|
-
/**
|
|
629
|
-
* The status of the processing job.
|
|
630
|
-
*
|
|
631
|
-
* Possible values: notStarted, running, succeeded, failed, partiallyCompleted
|
|
632
|
-
*/
|
|
633
|
-
readonly status: string;
|
|
634
|
-
/** An array of errors, if any errors occurred during the processing job. */
|
|
635
|
-
readonly errors?: Array<ErrorModelOutput>;
|
|
636
|
-
/** The inference results for the Trial Matcher request. */
|
|
637
|
-
readonly results?: TrialMatcherResultsOutput;
|
|
638
|
-
}
|
|
639
|
-
|
|
640
|
-
/** The inference results for the Trial Matcher request. */
|
|
641
|
-
export declare interface TrialMatcherResultsOutput {
|
|
642
|
-
/** Results for the patients given in the request. */
|
|
643
|
-
patients: Array<TrialMatcherPatientResultOutput>;
|
|
644
|
-
/** The version of the model used for inference, expressed as the model date. */
|
|
645
|
-
modelVersion: string;
|
|
646
|
-
/** The date when the clinical trials knowledge graph was last updated. */
|
|
647
|
-
knowledgeGraphLastUpdateDate?: string;
|
|
648
|
-
}
|
|
649
|
-
|
|
650
|
-
export { }
|