@azure-rest/health-insights-radiologyinsights 1.0.0-alpha.20241118.2 → 1.0.0-alpha.20241119.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 +2 -2
- package/types/health-insights-radiologyinsights-rest.d.ts +2194 -0
- package/types/samples-dev/sample_age_mismatch_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_age_mismatch_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_complete_order_discrepancy_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_complete_order_discrepancy_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_critical_result_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_critical_result_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_critical_result_managed_identity.d.ts +2 -0
- package/types/samples-dev/sample_critical_result_managed_identity.d.ts.map +1 -0
- package/types/samples-dev/sample_finding_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_finding_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_follow_up_communication_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_follow_up_communication_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_follow_up_recommendation_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_follow_up_recommendation_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_laterality_discrepancy_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_laterality_discrepancy_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_limited_order_discrepancy_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_limited_order_discrepancy_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_radiology_procedure_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_radiology_procedure_inference_async.d.ts.map +1 -0
- package/types/samples-dev/sample_sex_mismatch_inference_async.d.ts +2 -0
- package/types/samples-dev/sample_sex_mismatch_inference_async.d.ts.map +1 -0
- package/types/src/azureHealthInsightsClient.d.ts +11 -0
- package/types/src/azureHealthInsightsClient.d.ts.map +1 -0
- package/types/src/clientDefinitions.d.ts +21 -0
- package/types/src/clientDefinitions.d.ts.map +1 -0
- package/types/src/index.d.ts +12 -0
- package/types/src/index.d.ts.map +1 -0
- package/types/src/isUnexpected.d.ts +6 -0
- package/types/src/isUnexpected.d.ts.map +1 -0
- package/types/src/logger.d.ts +2 -0
- package/types/src/logger.d.ts.map +1 -0
- package/types/src/models.d.ts +909 -0
- package/types/src/models.d.ts.map +1 -0
- package/types/src/outputModels.d.ts +936 -0
- package/types/src/outputModels.d.ts.map +1 -0
- package/types/src/parameters.d.ts +32 -0
- package/types/src/parameters.d.ts.map +1 -0
- package/types/src/pollingHelper.d.ts +12 -0
- package/types/src/pollingHelper.d.ts.map +1 -0
- package/types/src/responses.d.ts +91 -0
- package/types/src/responses.d.ts.map +1 -0
- package/types/src/serializeHelper.d.ts +3 -0
- package/types/src/serializeHelper.d.ts.map +1 -0
- package/types/test/public/SampleAgeMismatchInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleAgeMismatchInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleCompleteOrderDiscrepancyInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleCompleteOrderDiscrepancyInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleCriticalResultInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleCriticalResultInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleFindingInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleFindingInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleFollowUpCommunicationAsync.spec.d.ts +2 -0
- package/types/test/public/SampleFollowUpCommunicationAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleFollowUpRecommendationAsync.spec.d.ts +2 -0
- package/types/test/public/SampleFollowUpRecommendationAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleLateralityDiscrepancyInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleLateralityDiscrepancyInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleLimitedOrderDiscrepancyInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleLimitedOrderDiscrepancyInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleRadiologyProcedureInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleRadiologyProcedureInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/SampleSexMismatchInferenceAsync.spec.d.ts +2 -0
- package/types/test/public/SampleSexMismatchInferenceAsync.spec.d.ts.map +1 -0
- package/types/test/public/Test_RadiologyInsights_async.spec.d.ts +2 -0
- package/types/test/public/Test_RadiologyInsights_async.spec.d.ts.map +1 -0
- package/types/test/public/utils/env.browser.d.ts +1 -0
- package/types/test/public/utils/env.browser.d.ts.map +1 -0
- package/types/test/public/utils/env.d.ts +2 -0
- package/types/test/public/utils/env.d.ts.map +1 -0
- package/types/test/public/utils/recordedClient.d.ts +13 -0
- package/types/test/public/utils/recordedClient.d.ts.map +1 -0
- package/types/tsdoc-metadata.json +11 -0
|
@@ -0,0 +1,2194 @@
|
|
|
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 { ErrorModel } from '@azure-rest/core-client';
|
|
5
|
+
import type { HttpResponse } from '@azure-rest/core-client';
|
|
6
|
+
import type { OperationState } from '@azure/core-lro';
|
|
7
|
+
import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
|
|
8
|
+
import type { RequestParameters } from '@azure-rest/core-client';
|
|
9
|
+
import type { SimplePollerLike } from '@azure/core-lro';
|
|
10
|
+
import type { StreamableMethod } from '@azure-rest/core-client';
|
|
11
|
+
import type { TokenCredential } from '@azure/core-auth';
|
|
12
|
+
|
|
13
|
+
/** A notification for age mismatch is displayed when the age mentioned in a document for a specific patient does not match the age specified in the patient information. */
|
|
14
|
+
export declare interface AgeMismatchInference extends RadiologyInsightsInferenceParent {
|
|
15
|
+
/** Inference type. */
|
|
16
|
+
kind: "ageMismatch";
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
/** A notification for age mismatch is displayed when the age mentioned in a document for a specific patient does not match the age specified in the patient information. */
|
|
20
|
+
export declare interface AgeMismatchInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
21
|
+
/** Inference type. */
|
|
22
|
+
kind: "ageMismatch";
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* A text note which also contains information about who made the statement and when
|
|
27
|
+
* Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation)
|
|
28
|
+
*/
|
|
29
|
+
export declare interface Annotation extends Element {
|
|
30
|
+
/** Individual responsible for the annotation */
|
|
31
|
+
authorString?: string;
|
|
32
|
+
/** When the annotation was made */
|
|
33
|
+
time?: string;
|
|
34
|
+
/** The annotation - text content (as markdown) */
|
|
35
|
+
text: string;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* A text note which also contains information about who made the statement and when
|
|
40
|
+
* Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation)
|
|
41
|
+
*/
|
|
42
|
+
export declare interface AnnotationOutput extends ElementOutput {
|
|
43
|
+
/** Individual responsible for the annotation */
|
|
44
|
+
authorString?: string;
|
|
45
|
+
/** When the annotation was made */
|
|
46
|
+
time?: string;
|
|
47
|
+
/** The annotation - text content (as markdown) */
|
|
48
|
+
text: string;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/** Create a HealthInsightsclient which is a Client an defined by the resource */
|
|
52
|
+
export declare type AzureHealthInsightsClient = Client & {
|
|
53
|
+
/** The path specified by the routes for the resource */
|
|
54
|
+
path: Routes;
|
|
55
|
+
};
|
|
56
|
+
|
|
57
|
+
/** Returns all parameters per item*/
|
|
58
|
+
export declare function buildMultiCollection(items: string[], parameterName: string): string;
|
|
59
|
+
|
|
60
|
+
/** Allowed types of documents to be evaluated, specified in an Enum */
|
|
61
|
+
export declare type ClinicalDocumentType = ClinicalDocumentTypeEnum;
|
|
62
|
+
|
|
63
|
+
/** Alias for ClinicalDocumentType */
|
|
64
|
+
export declare enum ClinicalDocumentTypeEnum {
|
|
65
|
+
/** Consultation documents */
|
|
66
|
+
Consultation = "consultation",
|
|
67
|
+
/** Discharge summary documents */
|
|
68
|
+
DischargeSummary = "dischargeSummary",
|
|
69
|
+
/** H&P documents */
|
|
70
|
+
HistoryAndPhysical = "historyAndPhysical",
|
|
71
|
+
/** Radiology documents */
|
|
72
|
+
RadiologyReport = "radiologyReport",
|
|
73
|
+
/** Procedure notes */
|
|
74
|
+
Procedure = "procedure",
|
|
75
|
+
/** Progress notes */
|
|
76
|
+
Progress = "progress",
|
|
77
|
+
/** Laboratory documents */
|
|
78
|
+
Laboratory = "laboratory"
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/** Output types of documents */
|
|
82
|
+
export declare type ClinicalDocumentTypeOutput = ClinicalDocumentTypeOutputEnum;
|
|
83
|
+
|
|
84
|
+
/** Alias for ClinicalDocumentTypeOutput */
|
|
85
|
+
export declare enum ClinicalDocumentTypeOutputEnum {
|
|
86
|
+
/** Consultation documents */
|
|
87
|
+
Consultation = "consultation",
|
|
88
|
+
/** Discharge summary documents */
|
|
89
|
+
DischargeSummary = "dischargeSummary",
|
|
90
|
+
/** H&P documents */
|
|
91
|
+
HistoryAndPhysical = "historyAndPhysical",
|
|
92
|
+
/** Radiology documents */
|
|
93
|
+
RadiologyReport = "radiologyReport",
|
|
94
|
+
/** Procedure notes */
|
|
95
|
+
Procedure = "procedure",
|
|
96
|
+
/** Progress notes */
|
|
97
|
+
Progress = "progress",
|
|
98
|
+
/** Laboratory documents */
|
|
99
|
+
Laboratory = "laboratory"
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Concept - reference to a terminology or just text
|
|
104
|
+
* Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept)
|
|
105
|
+
*/
|
|
106
|
+
export declare interface CodeableConcept extends Element {
|
|
107
|
+
/** Code defined by a terminology system */
|
|
108
|
+
coding?: Array<Coding>;
|
|
109
|
+
/** Plain text representation of the concept */
|
|
110
|
+
text?: string;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* Concept - reference to a terminology or just text
|
|
115
|
+
* Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept)
|
|
116
|
+
*/
|
|
117
|
+
export declare interface CodeableConceptOutput extends ElementOutput {
|
|
118
|
+
/** Code defined by a terminology system */
|
|
119
|
+
coding?: Array<CodingOutput>;
|
|
120
|
+
/** Plain text representation of the concept */
|
|
121
|
+
text?: string;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
/**
|
|
125
|
+
* A Coding is a representation of a defined concept using a symbol from a defined "code system".
|
|
126
|
+
* Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding)
|
|
127
|
+
*/
|
|
128
|
+
export declare interface Coding extends Element {
|
|
129
|
+
/** Identity of the terminology system */
|
|
130
|
+
system?: string;
|
|
131
|
+
/** Version of the system - if relevant */
|
|
132
|
+
version?: string;
|
|
133
|
+
/** Symbol in syntax defined by the system */
|
|
134
|
+
code?: string;
|
|
135
|
+
/** Representation defined by the system */
|
|
136
|
+
display?: string;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* A Coding is a representation of a defined concept using a symbol from a defined "code system".
|
|
141
|
+
* Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding)
|
|
142
|
+
*/
|
|
143
|
+
export declare interface CodingOutput extends ElementOutput {
|
|
144
|
+
/** Identity of the terminology system */
|
|
145
|
+
system?: string;
|
|
146
|
+
/** Version of the system - if relevant */
|
|
147
|
+
version?: string;
|
|
148
|
+
/** Symbol in syntax defined by the system */
|
|
149
|
+
code?: string;
|
|
150
|
+
/** Representation defined by the system */
|
|
151
|
+
display?: string;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/** A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present. */
|
|
155
|
+
export declare interface CompleteOrderDiscrepancyInference extends RadiologyInsightsInferenceParent {
|
|
156
|
+
/** Inference type. */
|
|
157
|
+
kind: "completeOrderDiscrepancy";
|
|
158
|
+
/** Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. */
|
|
159
|
+
orderType: CodeableConcept;
|
|
160
|
+
/** List of missing body parts required by a complete order : SNOMED CT codes. */
|
|
161
|
+
missingBodyParts?: Array<CodeableConcept>;
|
|
162
|
+
/** List of missing body parts that require measurement by a complete order : SNOMED CT codes. */
|
|
163
|
+
missingBodyPartMeasurements?: Array<CodeableConcept>;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
/** A complete order discrepancy is shown when one or more body parts and/or measurements that should be in the document (because there is a complete order) are not present. */
|
|
167
|
+
export declare interface CompleteOrderDiscrepancyInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
168
|
+
/** Inference type. */
|
|
169
|
+
kind: "completeOrderDiscrepancy";
|
|
170
|
+
/** Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. */
|
|
171
|
+
orderType: CodeableConceptOutput;
|
|
172
|
+
/** List of missing body parts required by a complete order : SNOMED CT codes. */
|
|
173
|
+
missingBodyParts?: Array<CodeableConceptOutput>;
|
|
174
|
+
/** List of missing body parts that require measurement by a complete order : SNOMED CT codes. */
|
|
175
|
+
missingBodyPartMeasurements?: Array<CodeableConceptOutput>;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Detailed information about conditions, problems or diagnoses
|
|
180
|
+
* Based on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html)
|
|
181
|
+
*/
|
|
182
|
+
export declare interface Condition extends DomainResourceParent {
|
|
183
|
+
/** resourceType */
|
|
184
|
+
resourceType: "Condition";
|
|
185
|
+
/** External Ids for this condition */
|
|
186
|
+
identifier?: Array<Identifier>;
|
|
187
|
+
/** active | recurrence | relapse | inactive | remission | resolved */
|
|
188
|
+
clinicalStatus?: CodeableConcept;
|
|
189
|
+
/** unconfirmed | provisional | differential | confirmed | refuted | entered-in-error */
|
|
190
|
+
verificationStatus?: CodeableConcept;
|
|
191
|
+
/** problem-list-item | encounter-diagnosis */
|
|
192
|
+
category?: Array<CodeableConcept>;
|
|
193
|
+
/** Subjective severity of condition */
|
|
194
|
+
severity?: CodeableConcept;
|
|
195
|
+
/** Identification of the condition, problem or diagnosis */
|
|
196
|
+
code?: CodeableConcept;
|
|
197
|
+
/** Anatomical location, if relevant */
|
|
198
|
+
bodySite?: Array<CodeableConcept>;
|
|
199
|
+
/** Encounter created as part of */
|
|
200
|
+
encounter?: Reference;
|
|
201
|
+
/** Estimated or actual date, date-time, or age */
|
|
202
|
+
onsetDateTime?: string;
|
|
203
|
+
/** Estimated or actual date, date-time, or age */
|
|
204
|
+
onsetAge?: Quantity;
|
|
205
|
+
/** Estimated or actual date, date-time, or age */
|
|
206
|
+
onsetPeriod?: Period;
|
|
207
|
+
/** Estimated or actual date, date-time, or age */
|
|
208
|
+
onsetRange?: Range;
|
|
209
|
+
/** Estimated or actual date, date-time, or age */
|
|
210
|
+
onsetString?: string;
|
|
211
|
+
/** When in resolution/remission */
|
|
212
|
+
abatementDateTime?: string;
|
|
213
|
+
/** When in resolution/remission */
|
|
214
|
+
abatementAge?: Quantity;
|
|
215
|
+
/** When in resolution/remission */
|
|
216
|
+
abatementPeriod?: Period;
|
|
217
|
+
/** When in resolution/remission */
|
|
218
|
+
abatementRange?: Range;
|
|
219
|
+
/** When in resolution/remission */
|
|
220
|
+
abatementString?: string;
|
|
221
|
+
/** Date record was first recorded */
|
|
222
|
+
recordedDate?: string;
|
|
223
|
+
/** stge/grade, usually assessed formally */
|
|
224
|
+
stage?: Array<ConditionStage>;
|
|
225
|
+
/** Additional information about the Condition */
|
|
226
|
+
note?: Array<Annotation>;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
/**
|
|
230
|
+
* Detailed information about conditions, problems or diagnoses
|
|
231
|
+
* Based on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html)
|
|
232
|
+
*/
|
|
233
|
+
export declare interface ConditionOutput extends DomainResourceOutputParent {
|
|
234
|
+
/** resourceType */
|
|
235
|
+
resourceType: "Condition";
|
|
236
|
+
/** External Ids for this condition */
|
|
237
|
+
identifier?: Array<IdentifierOutput>;
|
|
238
|
+
/** active | recurrence | relapse | inactive | remission | resolved */
|
|
239
|
+
clinicalStatus?: CodeableConceptOutput;
|
|
240
|
+
/** unconfirmed | provisional | differential | confirmed | refuted | entered-in-error */
|
|
241
|
+
verificationStatus?: CodeableConceptOutput;
|
|
242
|
+
/** problem-list-item | encounter-diagnosis */
|
|
243
|
+
category?: Array<CodeableConceptOutput>;
|
|
244
|
+
/** Subjective severity of condition */
|
|
245
|
+
severity?: CodeableConceptOutput;
|
|
246
|
+
/** Identification of the condition, problem or diagnosis */
|
|
247
|
+
code?: CodeableConceptOutput;
|
|
248
|
+
/** Anatomical location, if relevant */
|
|
249
|
+
bodySite?: Array<CodeableConceptOutput>;
|
|
250
|
+
/** Encounter created as part of */
|
|
251
|
+
encounter?: ReferenceOutput;
|
|
252
|
+
/** Estimated or actual date, date-time, or age */
|
|
253
|
+
onsetDateTime?: string;
|
|
254
|
+
/** Estimated or actual date, date-time, or age */
|
|
255
|
+
onsetAge?: QuantityOutput;
|
|
256
|
+
/** Estimated or actual date, date-time, or age */
|
|
257
|
+
onsetPeriod?: PeriodOutput;
|
|
258
|
+
/** Estimated or actual date, date-time, or age */
|
|
259
|
+
onsetRange?: RangeOutput;
|
|
260
|
+
/** Estimated or actual date, date-time, or age */
|
|
261
|
+
onsetString?: string;
|
|
262
|
+
/** When in resolution/remission */
|
|
263
|
+
abatementDateTime?: string;
|
|
264
|
+
/** When in resolution/remission */
|
|
265
|
+
abatementAge?: QuantityOutput;
|
|
266
|
+
/** When in resolution/remission */
|
|
267
|
+
abatementPeriod?: PeriodOutput;
|
|
268
|
+
/** When in resolution/remission */
|
|
269
|
+
abatementRange?: RangeOutput;
|
|
270
|
+
/** When in resolution/remission */
|
|
271
|
+
abatementString?: string;
|
|
272
|
+
/** Date record was first recorded */
|
|
273
|
+
recordedDate?: string;
|
|
274
|
+
/** stge/grade, usually assessed formally */
|
|
275
|
+
stage?: Array<ConditionStageOutput>;
|
|
276
|
+
/** Additional information about the Condition */
|
|
277
|
+
note?: Array<AnnotationOutput>;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
/**
|
|
281
|
+
* Stage/grade, usually assessed formally
|
|
282
|
+
* Based on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html)
|
|
283
|
+
*/
|
|
284
|
+
export declare interface ConditionStage {
|
|
285
|
+
/** Simple summary (disease specific) */
|
|
286
|
+
summary?: CodeableConcept;
|
|
287
|
+
/** Kind of staging */
|
|
288
|
+
type?: CodeableConcept;
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
/**
|
|
292
|
+
* Stage/grade, usually assessed formally
|
|
293
|
+
* Based on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html)
|
|
294
|
+
*/
|
|
295
|
+
export declare interface ConditionStageOutput {
|
|
296
|
+
/** Simple summary (disease specific) */
|
|
297
|
+
summary?: CodeableConceptOutput;
|
|
298
|
+
/** Kind of staging */
|
|
299
|
+
type?: CodeableConceptOutput;
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
/** Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail) */
|
|
303
|
+
export declare interface ContactDetail extends Element {
|
|
304
|
+
/** Name of an individual to contact */
|
|
305
|
+
name?: string;
|
|
306
|
+
/** Contact details for individual or organization */
|
|
307
|
+
telecom?: Array<ContactPoint>;
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
/** Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail) */
|
|
311
|
+
export declare interface ContactDetailOutput extends ElementOutput {
|
|
312
|
+
/** Name of an individual to contact */
|
|
313
|
+
name?: string;
|
|
314
|
+
/** Contact details for individual or organization */
|
|
315
|
+
telecom?: Array<ContactPointOutput>;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
|
|
320
|
+
* See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint
|
|
321
|
+
*/
|
|
322
|
+
export declare interface ContactPoint {
|
|
323
|
+
/** phone | fax | email | pager | url | sms | other */
|
|
324
|
+
system?: ContactPointSystem;
|
|
325
|
+
/** The actual contact point details */
|
|
326
|
+
value?: string;
|
|
327
|
+
/** home | work | temp | old | mobile - purpose of this contact point */
|
|
328
|
+
use?: ContactPointUse;
|
|
329
|
+
/** Specify preferred order of use (1 = highest) */
|
|
330
|
+
rank?: number;
|
|
331
|
+
/** Time period when the contact point was/is in use */
|
|
332
|
+
period?: Period;
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
/**
|
|
336
|
+
* Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
|
|
337
|
+
* See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint
|
|
338
|
+
*/
|
|
339
|
+
export declare interface ContactPointOutput {
|
|
340
|
+
/** phone | fax | email | pager | url | sms | other */
|
|
341
|
+
system?: ContactPointSystemOutput;
|
|
342
|
+
/** The actual contact point details */
|
|
343
|
+
value?: string;
|
|
344
|
+
/** home | work | temp | old | mobile - purpose of this contact point */
|
|
345
|
+
use?: ContactPointUseOutput;
|
|
346
|
+
/** Specify preferred order of use (1 = highest) */
|
|
347
|
+
rank?: number;
|
|
348
|
+
/** Time period when the contact point was/is in use */
|
|
349
|
+
period?: PeriodOutput;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
/** Alias for ContactPointSystem */
|
|
353
|
+
export declare type ContactPointSystem = string | "phone" | "fax" | "email" | "pager" | "url" | "sms" | "other";
|
|
354
|
+
|
|
355
|
+
/** Alias for ContactPointSystemOutput */
|
|
356
|
+
export declare type ContactPointSystemOutput = string | "phone" | "fax" | "email" | "pager" | "url" | "sms" | "other";
|
|
357
|
+
|
|
358
|
+
/** Alias for ContactPointUse */
|
|
359
|
+
export declare type ContactPointUse = string | "home" | "work" | "temp" | "old" | "mobile";
|
|
360
|
+
|
|
361
|
+
/** Alias for ContactPointUseOutput */
|
|
362
|
+
export declare type ContactPointUseOutput = string | "home" | "work" | "temp" | "old" | "mobile";
|
|
363
|
+
|
|
364
|
+
/**
|
|
365
|
+
* Initialize a new instance of `AzureHealthInsightsClient`
|
|
366
|
+
* @param endpointParam - Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.cognitiveservices.azure.com).
|
|
367
|
+
* @param credentials - uniquely identify client credential
|
|
368
|
+
* @param options - the parameter for all optional parameters
|
|
369
|
+
*/
|
|
370
|
+
declare function createClient(endpointParam: string, credentials: TokenCredential, options?: ClientOptions): AzureHealthInsightsClient;
|
|
371
|
+
export default createClient;
|
|
372
|
+
|
|
373
|
+
/** Creation of the Headers of the request */
|
|
374
|
+
export declare interface CreateJob200Headers {
|
|
375
|
+
/** An opaque, globally-unique, server-generated string identifier for the request. */
|
|
376
|
+
"x-ms-request-id"?: string;
|
|
377
|
+
/** The location for monitoring the operation state. */
|
|
378
|
+
"operation-location": string;
|
|
379
|
+
}
|
|
380
|
+
|
|
381
|
+
/** The request has succeeded. Create job response */
|
|
382
|
+
export declare interface CreateJob200Response extends HttpResponse {
|
|
383
|
+
/** The status of the request */
|
|
384
|
+
status: "200";
|
|
385
|
+
/** The body of the request */
|
|
386
|
+
body: RadiologyInsightsJobOutput;
|
|
387
|
+
/** The headers of the request */
|
|
388
|
+
headers: RawHttpHeaders & CreateJob200Headers;
|
|
389
|
+
}
|
|
390
|
+
|
|
391
|
+
/** Creation of the new resource headers after request has succeeded */
|
|
392
|
+
export declare interface CreateJob201Headers {
|
|
393
|
+
/** An opaque, globally-unique, server-generated string identifier for the request. */
|
|
394
|
+
"x-ms-request-id"?: string;
|
|
395
|
+
/** The location for monitoring the operation state. */
|
|
396
|
+
"operation-location": string;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
/** The request has succeeded and a new resource has been created as a result. */
|
|
400
|
+
export declare interface CreateJob201Response extends HttpResponse {
|
|
401
|
+
/** The status of the new resource created */
|
|
402
|
+
status: "201";
|
|
403
|
+
/** The body of the new resource created*/
|
|
404
|
+
body: RadiologyInsightsJobOutput;
|
|
405
|
+
/** The headers of the new resource created */
|
|
406
|
+
headers: RawHttpHeaders & CreateJob201Headers;
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
/** The create job body parameters. */
|
|
410
|
+
export declare interface CreateJobBodyParam {
|
|
411
|
+
/** The body of the resource instance. */
|
|
412
|
+
body: RadiologyInsightsJob;
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
/** The default header request creation */
|
|
416
|
+
export declare interface CreateJobDefaultHeaders {
|
|
417
|
+
/** String error code indicating what went wrong. */
|
|
418
|
+
"x-ms-error-code"?: string;
|
|
419
|
+
/** An opaque, globally-unique, server-generated string identifier for the request. */
|
|
420
|
+
"x-ms-request-id"?: string;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
/** The default header response creation */
|
|
424
|
+
export declare interface CreateJobDefaultResponse extends HttpResponse {
|
|
425
|
+
/** The status of the default response */
|
|
426
|
+
status: string;
|
|
427
|
+
/** The body of the default response */
|
|
428
|
+
body: HealthInsightsErrorResponseOutput;
|
|
429
|
+
/** The headers of the default response */
|
|
430
|
+
headers: RawHttpHeaders & CreateJobDefaultHeaders;
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
/** The final response for long-running createJob operation */
|
|
434
|
+
export declare interface CreateJobLogicalResponse extends HttpResponse {
|
|
435
|
+
/** The status of the final response */
|
|
436
|
+
status: "200";
|
|
437
|
+
/** The body of the final response */
|
|
438
|
+
body: RadiologyInsightsJobOutput;
|
|
439
|
+
}
|
|
440
|
+
|
|
441
|
+
/** Create the job parameters, combining the create query parameters, the create job body paramters and the request parameters */
|
|
442
|
+
export declare type CreateJobParameters = CreateJobQueryParam & CreateJobBodyParam & RequestParameters;
|
|
443
|
+
|
|
444
|
+
/** The create job query parameter. */
|
|
445
|
+
export declare interface CreateJobQueryParam {
|
|
446
|
+
/** The query parameters. */
|
|
447
|
+
queryParameters?: CreateJobQueryParamProperties;
|
|
448
|
+
}
|
|
449
|
+
|
|
450
|
+
/** The create job query parameter properties. */
|
|
451
|
+
export declare interface CreateJobQueryParamProperties {
|
|
452
|
+
/** Expand the indicated resources into the response. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */
|
|
453
|
+
expand?: string;
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
/** Critical Result consists of two properties. */
|
|
457
|
+
export declare interface CriticalResult {
|
|
458
|
+
/** Description : medical problem. */
|
|
459
|
+
description: string;
|
|
460
|
+
/** Finding linked to the critical result. */
|
|
461
|
+
finding?: Observation;
|
|
462
|
+
}
|
|
463
|
+
|
|
464
|
+
/** Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care. */
|
|
465
|
+
export declare interface CriticalResultInference extends RadiologyInsightsInferenceParent {
|
|
466
|
+
/** Inference type. */
|
|
467
|
+
kind: "criticalResult";
|
|
468
|
+
/** The complete Critical Result, as outlined below, will be reused for the recommendation. */
|
|
469
|
+
result: CriticalResult;
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
/** Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care. */
|
|
473
|
+
export declare interface CriticalResultInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
474
|
+
/** Inference type. */
|
|
475
|
+
kind: "criticalResult";
|
|
476
|
+
/** The complete Critical Result, as outlined below, will be reused for the recommendation. */
|
|
477
|
+
result: CriticalResultOutput;
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
/** Critical Result consists of two properties. */
|
|
481
|
+
export declare interface CriticalResultOutput {
|
|
482
|
+
/** Description : medical problem. */
|
|
483
|
+
description: string;
|
|
484
|
+
/** Finding linked to the critical result. */
|
|
485
|
+
finding?: ObservationOutput;
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
/** Document administrative metadata */
|
|
489
|
+
export declare interface DocumentAdministrativeMetadata {
|
|
490
|
+
/** List of procedure information associated with the document. */
|
|
491
|
+
orderedProcedures?: Array<OrderedProcedure>;
|
|
492
|
+
/** Reference to the encounter associated with the document. */
|
|
493
|
+
encounterId?: string;
|
|
494
|
+
}
|
|
495
|
+
|
|
496
|
+
/** Document administrative metadata */
|
|
497
|
+
export declare interface DocumentAdministrativeMetadataOutput {
|
|
498
|
+
/** List of procedure information associated with the document. */
|
|
499
|
+
orderedProcedures?: Array<OrderedProcedureOutput>;
|
|
500
|
+
/** Reference to the encounter associated with the document. */
|
|
501
|
+
encounterId?: string;
|
|
502
|
+
}
|
|
503
|
+
|
|
504
|
+
/** Document author */
|
|
505
|
+
export declare interface DocumentAuthor {
|
|
506
|
+
/** author id */
|
|
507
|
+
id?: string;
|
|
508
|
+
/** Text representation of the full name */
|
|
509
|
+
fullName?: string;
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
/** Document author */
|
|
513
|
+
export declare interface DocumentAuthorOutput {
|
|
514
|
+
/** author id */
|
|
515
|
+
id?: string;
|
|
516
|
+
/** Text representation of the full name */
|
|
517
|
+
fullName?: string;
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
/** The content of the patient document. */
|
|
521
|
+
export declare interface DocumentContent {
|
|
522
|
+
/**
|
|
523
|
+
* The type of the content's source.
|
|
524
|
+
* In case the source type is 'inline', the content is given as a string (for instance, text).
|
|
525
|
+
* In case the source type is 'reference', the content is given as a URI.
|
|
526
|
+
*/
|
|
527
|
+
sourceType: DocumentContentSourceType;
|
|
528
|
+
/** The content of the document, given either inline (as a string) or as a reference (URI). */
|
|
529
|
+
value: string;
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
/** The content of the patient document. */
|
|
533
|
+
export declare interface DocumentContentOutput {
|
|
534
|
+
/**
|
|
535
|
+
* The type of the content's source.
|
|
536
|
+
* In case the source type is 'inline', the content is given as a string (for instance, text).
|
|
537
|
+
* In case the source type is 'reference', the content is given as a URI.
|
|
538
|
+
*/
|
|
539
|
+
sourceType: DocumentContentSourceTypeOutput;
|
|
540
|
+
/** The content of the document, given either inline (as a string) or as a reference (URI). */
|
|
541
|
+
value: string;
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
/** Alias for DocumentContentSourceType */
|
|
545
|
+
export declare type DocumentContentSourceType = string | "inline" | "reference";
|
|
546
|
+
|
|
547
|
+
/** Alias for DocumentContentSourceTypeOutput */
|
|
548
|
+
export declare type DocumentContentSourceTypeOutput = string | "inline" | "reference";
|
|
549
|
+
|
|
550
|
+
/** Alias for DocumentType */
|
|
551
|
+
export declare type DocumentType = string | "note" | "fhirBundle" | "dicom" | "genomicSequencing";
|
|
552
|
+
|
|
553
|
+
/** Alias for DocumentTypeOutput */
|
|
554
|
+
export declare type DocumentTypeOutput = string | "note" | "fhirBundle" | "dicom" | "genomicSequencing";
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* A resource with narrative, extensions, and contained resources
|
|
558
|
+
* Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)
|
|
559
|
+
*/
|
|
560
|
+
export declare type DomainResource = DomainResourceParent | Observation | Condition | ResearchStudy;
|
|
561
|
+
|
|
562
|
+
/**
|
|
563
|
+
* A resource with narrative, extensions, and contained resources
|
|
564
|
+
* Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)
|
|
565
|
+
*/
|
|
566
|
+
export declare type DomainResourceOutput = DomainResourceOutputParent | ObservationOutput | ConditionOutput | ResearchStudyOutput;
|
|
567
|
+
|
|
568
|
+
/**
|
|
569
|
+
* A resource with narrative, extensions, and contained resources
|
|
570
|
+
* Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)
|
|
571
|
+
*/
|
|
572
|
+
export declare interface DomainResourceOutputParent extends ResourceOutput {
|
|
573
|
+
/** Text summary of the resource, for human interpretation */
|
|
574
|
+
text?: NarrativeOutput;
|
|
575
|
+
/** Contained, inline Resources */
|
|
576
|
+
contained?: Array<ResourceOutput>;
|
|
577
|
+
/** Additional Content defined by implementations */
|
|
578
|
+
extension?: Array<ExtensionOutput>;
|
|
579
|
+
/** Extensions that cannot be ignored */
|
|
580
|
+
modifierExtension?: Array<ExtensionOutput>;
|
|
581
|
+
/** resourceType */
|
|
582
|
+
resourceType: string;
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* A resource with narrative, extensions, and contained resources
|
|
587
|
+
* Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)
|
|
588
|
+
*/
|
|
589
|
+
export declare interface DomainResourceParent extends Resource {
|
|
590
|
+
/** Text summary of the resource, for human interpretation */
|
|
591
|
+
text?: Narrative;
|
|
592
|
+
/** Contained, inline Resources */
|
|
593
|
+
contained?: Array<Resource>;
|
|
594
|
+
/** Additional Content defined by implementations */
|
|
595
|
+
extension?: Array<Extension>;
|
|
596
|
+
/** Extensions that cannot be ignored */
|
|
597
|
+
modifierExtension?: Array<Extension>;
|
|
598
|
+
/** resourceType */
|
|
599
|
+
resourceType: string;
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
/**
|
|
603
|
+
* The base definition for all elements contained inside a resource.
|
|
604
|
+
* Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)
|
|
605
|
+
*/
|
|
606
|
+
export declare interface Element {
|
|
607
|
+
/** Unique id for inter-element referencing */
|
|
608
|
+
id?: string;
|
|
609
|
+
/** Additional Content defined by implementations */
|
|
610
|
+
extension?: Array<Extension>;
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
/**
|
|
614
|
+
* The base definition for all elements contained inside a resource.
|
|
615
|
+
* Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)
|
|
616
|
+
*/
|
|
617
|
+
export declare interface ElementOutput {
|
|
618
|
+
/** Unique id for inter-element referencing */
|
|
619
|
+
id?: string;
|
|
620
|
+
/** Additional Content defined by implementations */
|
|
621
|
+
extension?: Array<ExtensionOutput>;
|
|
622
|
+
}
|
|
623
|
+
|
|
624
|
+
/** Alias for EncounterClass */
|
|
625
|
+
export declare type EncounterClass = string | "inpatient" | "ambulatory" | "observation" | "emergency" | "virtual" | "healthHome";
|
|
626
|
+
|
|
627
|
+
/** Alias for EncounterClassOutput */
|
|
628
|
+
export declare type EncounterClassOutput = string | "inpatient" | "ambulatory" | "observation" | "emergency" | "virtual" | "healthHome";
|
|
629
|
+
|
|
630
|
+
/**
|
|
631
|
+
* Base for all elements
|
|
632
|
+
* Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element)
|
|
633
|
+
*/
|
|
634
|
+
export declare interface Extension extends Element {
|
|
635
|
+
/** Source of the definition for the extension code - a logical name or a URL. */
|
|
636
|
+
url: string;
|
|
637
|
+
/** Value as Quantity */
|
|
638
|
+
valueQuantity?: Quantity;
|
|
639
|
+
/** Value as CodeableConcept */
|
|
640
|
+
valueCodeableConcept?: CodeableConcept;
|
|
641
|
+
/** Value as string */
|
|
642
|
+
valueString?: string;
|
|
643
|
+
/** Value as boolean */
|
|
644
|
+
valueBoolean?: boolean;
|
|
645
|
+
/** Value as integer */
|
|
646
|
+
valueInteger?: number;
|
|
647
|
+
/** Value as Range. */
|
|
648
|
+
valueRange?: Range;
|
|
649
|
+
/** Value as Ratio. */
|
|
650
|
+
valueRatio?: Ratio;
|
|
651
|
+
/** Value as SampledData. */
|
|
652
|
+
valueSampledData?: SampledData;
|
|
653
|
+
/** Value as time (hh:mm:ss) */
|
|
654
|
+
valueTime?: Date | string;
|
|
655
|
+
/** Value as dateTime. */
|
|
656
|
+
valueDateTime?: string;
|
|
657
|
+
/** Value as Period. */
|
|
658
|
+
valuePeriod?: Period;
|
|
659
|
+
/** Value as reference. */
|
|
660
|
+
valueReference?: Reference;
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
/**
|
|
664
|
+
* Base for all elements
|
|
665
|
+
* Based on [FHIR Element](https://www.hl7.org/fhir/datatypes.html#Element)
|
|
666
|
+
*/
|
|
667
|
+
export declare interface ExtensionOutput extends ElementOutput {
|
|
668
|
+
/** Source of the definition for the extension code - a logical name or a URL. */
|
|
669
|
+
url: string;
|
|
670
|
+
/** Value as Quantity */
|
|
671
|
+
valueQuantity?: QuantityOutput;
|
|
672
|
+
/** Value as CodeableConcept */
|
|
673
|
+
valueCodeableConcept?: CodeableConceptOutput;
|
|
674
|
+
/** Value as string */
|
|
675
|
+
valueString?: string;
|
|
676
|
+
/** Value as boolean */
|
|
677
|
+
valueBoolean?: boolean;
|
|
678
|
+
/** Value as integer */
|
|
679
|
+
valueInteger?: number;
|
|
680
|
+
/** Value as Range. */
|
|
681
|
+
valueRange?: RangeOutput;
|
|
682
|
+
/** Value as Ratio. */
|
|
683
|
+
valueRatio?: RatioOutput;
|
|
684
|
+
/** Value as SampledData. */
|
|
685
|
+
valueSampledData?: SampledDataOutput;
|
|
686
|
+
/** Value as time (hh:mm:ss) */
|
|
687
|
+
valueTime?: string;
|
|
688
|
+
/** Value as dateTime. */
|
|
689
|
+
valueDateTime?: string;
|
|
690
|
+
/** Value as Period. */
|
|
691
|
+
valuePeriod?: PeriodOutput;
|
|
692
|
+
/** Value as reference. */
|
|
693
|
+
valueReference?: ReferenceOutput;
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
/** Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area. */
|
|
697
|
+
export declare interface FindingInference extends RadiologyInsightsInferenceParent {
|
|
698
|
+
/** Inference type. */
|
|
699
|
+
kind: "finding";
|
|
700
|
+
/** Finding data : contains extensions, fields and components linked with the finding. */
|
|
701
|
+
finding: Observation;
|
|
702
|
+
}
|
|
703
|
+
|
|
704
|
+
/** Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area. */
|
|
705
|
+
export declare interface FindingInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
706
|
+
/** Inference type. */
|
|
707
|
+
kind: "finding";
|
|
708
|
+
/** Finding data : contains extensions, fields and components linked with the finding. */
|
|
709
|
+
finding: ObservationOutput;
|
|
710
|
+
}
|
|
711
|
+
|
|
712
|
+
/** Finding options. */
|
|
713
|
+
export declare interface FindingOptions {
|
|
714
|
+
/** If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false. */
|
|
715
|
+
provideFocusedSentenceEvidence?: boolean;
|
|
716
|
+
}
|
|
717
|
+
|
|
718
|
+
/** Finding options. */
|
|
719
|
+
export declare interface FindingOptionsOutput {
|
|
720
|
+
/** If this is true, provide the sentence that contains the first token of the finding's clinical indicator (i.e. the medical problem), if there is one. This sentence is provided as an extension with url 'ci_sentence', next to the token evidence. Default is false. */
|
|
721
|
+
provideFocusedSentenceEvidence?: boolean;
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
/** Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care. */
|
|
725
|
+
export declare interface FollowupCommunicationInference extends RadiologyInsightsInferenceParent {
|
|
726
|
+
/** Inference type. */
|
|
727
|
+
kind: "followupCommunication";
|
|
728
|
+
/** Communication date and time. */
|
|
729
|
+
communicatedAt?: Date[] | string[];
|
|
730
|
+
/** Recipient of the communication. */
|
|
731
|
+
recipient?: MedicalProfessionalType[];
|
|
732
|
+
/** Communication was acknowledged. */
|
|
733
|
+
wasAcknowledged: boolean;
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
/** Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care. */
|
|
737
|
+
export declare interface FollowupCommunicationInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
738
|
+
/** Inference type. */
|
|
739
|
+
kind: "followupCommunication";
|
|
740
|
+
/** Communication date and time. */
|
|
741
|
+
communicatedAt?: string[];
|
|
742
|
+
/** Recipient of the communication. */
|
|
743
|
+
recipient?: MedicalProfessionalTypeOutput[];
|
|
744
|
+
/** Communication was acknowledged. */
|
|
745
|
+
wasAcknowledged: boolean;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
/** Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies. */
|
|
749
|
+
export declare interface FollowupRecommendationInference extends RadiologyInsightsInferenceParent {
|
|
750
|
+
/** Inference type. */
|
|
751
|
+
kind: "followupRecommendation";
|
|
752
|
+
/** Date and time are displayed when the procedure is recommended to be done at a specific point in time. */
|
|
753
|
+
effectiveAt?: string;
|
|
754
|
+
/** The period is shown if a specific period is mentioned, with a start and end date-time. */
|
|
755
|
+
effectivePeriod?: Period;
|
|
756
|
+
/** Findings related to the recommendation. */
|
|
757
|
+
findings?: Array<RecommendationFinding>;
|
|
758
|
+
/** The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on. */
|
|
759
|
+
isConditional: boolean;
|
|
760
|
+
/** The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on. */
|
|
761
|
+
isOption: boolean;
|
|
762
|
+
/** The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings. */
|
|
763
|
+
isGuideline: boolean;
|
|
764
|
+
/** Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on. */
|
|
765
|
+
isHedging: boolean;
|
|
766
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
767
|
+
recommendedProcedure: ProcedureRecommendation;
|
|
768
|
+
}
|
|
769
|
+
|
|
770
|
+
/** Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies. */
|
|
771
|
+
export declare interface FollowupRecommendationInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
772
|
+
/** Inference type. */
|
|
773
|
+
kind: "followupRecommendation";
|
|
774
|
+
/** Date and time are displayed when the procedure is recommended to be done at a specific point in time. */
|
|
775
|
+
effectiveAt?: string;
|
|
776
|
+
/** The period is shown if a specific period is mentioned, with a start and end date-time. */
|
|
777
|
+
effectivePeriod?: PeriodOutput;
|
|
778
|
+
/** Findings related to the recommendation. */
|
|
779
|
+
findings?: Array<RecommendationFindingOutput>;
|
|
780
|
+
/** The conditional value indicates whether or not the sentence containing the recommendation includes a conditional statement. Keywords for conditional statements include 'if', 'when', 'unless', and so on. */
|
|
781
|
+
isConditional: boolean;
|
|
782
|
+
/** The option value indicates whether or not the sentence containing the recommendation includes an optional statement. Keywords for optional statements include 'recommend', 'consider', and so on. */
|
|
783
|
+
isOption: boolean;
|
|
784
|
+
/** The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings. */
|
|
785
|
+
isGuideline: boolean;
|
|
786
|
+
/** Hedging refers to ambiguous, vague or imprecise language within the sentence of the recommendation. Keywords for hedging are 'can be','may be',and so on. */
|
|
787
|
+
isHedging: boolean;
|
|
788
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
789
|
+
recommendedProcedure: ProcedureRecommendationOutput;
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
/** Follow-up recommendation options. */
|
|
793
|
+
export declare interface FollowupRecommendationOptions {
|
|
794
|
+
/** Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false. */
|
|
795
|
+
includeRecommendationsWithNoSpecifiedModality?: boolean;
|
|
796
|
+
/** Include/Exclude follow-up recommendations in references to a guideline or article. Default is false. */
|
|
797
|
+
includeRecommendationsInReferences?: boolean;
|
|
798
|
+
/** If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false. */
|
|
799
|
+
provideFocusedSentenceEvidence?: boolean;
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
/** Follow-up recommendation options. */
|
|
803
|
+
export declare interface FollowupRecommendationOptionsOutput {
|
|
804
|
+
/** Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false. */
|
|
805
|
+
includeRecommendationsWithNoSpecifiedModality?: boolean;
|
|
806
|
+
/** Include/Exclude follow-up recommendations in references to a guideline or article. Default is false. */
|
|
807
|
+
includeRecommendationsInReferences?: boolean;
|
|
808
|
+
/** If this is true, provide one or more sentences as evidence for the recommendation, next to the token evidence. The start and end positions of these sentences will be put in an extension with url 'modality_sentences'. Default is false. */
|
|
809
|
+
provideFocusedSentenceEvidence?: boolean;
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
/** Generic procedure information. */
|
|
813
|
+
export declare interface GenericProcedureRecommendation extends ProcedureRecommendationParent {
|
|
814
|
+
/** Procedure type : generic. */
|
|
815
|
+
kind: "genericProcedureRecommendation";
|
|
816
|
+
/** Procedure modality : SNOMED CT code. */
|
|
817
|
+
code: CodeableConcept;
|
|
818
|
+
/** Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT. */
|
|
819
|
+
description?: string;
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
/** Generic procedure information. */
|
|
823
|
+
export declare interface GenericProcedureRecommendationOutput extends ProcedureRecommendationOutputParent {
|
|
824
|
+
/** Procedure type : generic. */
|
|
825
|
+
kind: "genericProcedureRecommendation";
|
|
826
|
+
/** Procedure modality : SNOMED CT code. */
|
|
827
|
+
code: CodeableConceptOutput;
|
|
828
|
+
/** Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT. */
|
|
829
|
+
description?: string;
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
/** Gets the Radiology Insights job. */
|
|
833
|
+
export declare interface GetJob {
|
|
834
|
+
/** Gets the status and details of the Radiology Insights job. */
|
|
835
|
+
get(options?: GetJobParameters): StreamableMethod<GetJob200Response | GetJobDefaultResponse>;
|
|
836
|
+
/** Creates a Radiology Insights job with the given request body. */
|
|
837
|
+
put(options: CreateJobParameters, requestOptions?: GetJobParameters): StreamableMethod<CreateJob200Response | CreateJob201Response | CreateJobDefaultResponse>;
|
|
838
|
+
}
|
|
839
|
+
|
|
840
|
+
/** Get the headers of the succeeded request */
|
|
841
|
+
export declare interface GetJob200Headers {
|
|
842
|
+
/** The Retry-After header can indicate how long the client should wait before polling the operation status. */
|
|
843
|
+
"retry-after"?: number;
|
|
844
|
+
/** An opaque, globally-unique, server-generated string identifier for the request. */
|
|
845
|
+
"x-ms-request-id"?: string;
|
|
846
|
+
}
|
|
847
|
+
|
|
848
|
+
/** The request has succeeded. Get job response */
|
|
849
|
+
export declare interface GetJob200Response extends HttpResponse {
|
|
850
|
+
/** The status of the request */
|
|
851
|
+
status: "200";
|
|
852
|
+
/** The body of the request */
|
|
853
|
+
body: RadiologyInsightsJobOutput;
|
|
854
|
+
/** The header of the request */
|
|
855
|
+
headers: RawHttpHeaders & GetJob200Headers;
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
/** Get the default headers of the request */
|
|
859
|
+
export declare interface GetJobDefaultHeaders {
|
|
860
|
+
/** String error code indicating what went wrong. */
|
|
861
|
+
"x-ms-error-code"?: string;
|
|
862
|
+
/** An opaque, globally-unique, server-generated string identifier for the request. */
|
|
863
|
+
"x-ms-request-id"?: string;
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
/** Get the default Response */
|
|
867
|
+
export declare interface GetJobDefaultResponse extends HttpResponse {
|
|
868
|
+
/** The status of the default response */
|
|
869
|
+
status: string;
|
|
870
|
+
/** The body of the default response */
|
|
871
|
+
body: HealthInsightsErrorResponseOutput;
|
|
872
|
+
/** The headers of the default response */
|
|
873
|
+
headers: RawHttpHeaders & GetJobDefaultHeaders;
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
/** Get the job parameters, combining the query and request parameters */
|
|
877
|
+
export declare type GetJobParameters = GetJobQueryParam & RequestParameters;
|
|
878
|
+
|
|
879
|
+
/** Get the job query parameters */
|
|
880
|
+
export declare interface GetJobQueryParam {
|
|
881
|
+
/** The query parameters. */
|
|
882
|
+
queryParameters?: GetJobQueryParamProperties;
|
|
883
|
+
}
|
|
884
|
+
|
|
885
|
+
/** Get the job query parameter properties */
|
|
886
|
+
export declare interface GetJobQueryParamProperties {
|
|
887
|
+
/** Expand the indicated resources into the response. This parameter needs to be formatted as multi collection, we provide buildMultiCollection from serializeHelper.ts to help, you will probably need to set skipUrlEncoding as true when sending the request */
|
|
888
|
+
expand?: string;
|
|
889
|
+
}
|
|
890
|
+
|
|
891
|
+
/**
|
|
892
|
+
* Helper function that builds a Poller object to help polling a long running operation.
|
|
893
|
+
* @param client - Client to use for sending the request to get additional pages.
|
|
894
|
+
* @param initialResponse - The initial response.
|
|
895
|
+
* @param options - Options to set a resume state or custom polling interval.
|
|
896
|
+
* @returns - A poller object to poll for operation state updates and eventually get the final response.
|
|
897
|
+
*/
|
|
898
|
+
export declare function getLongRunningPoller<TResult extends CreateJobLogicalResponse | CreateJobDefaultResponse>(client: Client, initialResponse: CreateJob200Response | CreateJob201Response | CreateJobDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
|
|
899
|
+
|
|
900
|
+
/** A response containing error details. */
|
|
901
|
+
export declare interface HealthInsightsErrorResponseOutput {
|
|
902
|
+
/** The error object. */
|
|
903
|
+
error: ErrorModel;
|
|
904
|
+
/** An opaque, globally-unique, server-generated string identifier for the request. */
|
|
905
|
+
requestId: {
|
|
906
|
+
response: RequestIdResponseHeaderOutput;
|
|
907
|
+
};
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
/**
|
|
911
|
+
* An identifier intended for computation
|
|
912
|
+
* Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)
|
|
913
|
+
*/
|
|
914
|
+
export declare interface Identifier extends Element {
|
|
915
|
+
/** usual | official | temp | secondary | old (If known) */
|
|
916
|
+
use?: string;
|
|
917
|
+
/** Description of identifier */
|
|
918
|
+
type?: CodeableConcept;
|
|
919
|
+
/** The namespace for the identifier value */
|
|
920
|
+
system?: string;
|
|
921
|
+
/** The value that is unique */
|
|
922
|
+
value?: string;
|
|
923
|
+
/** Time period when id is/was valid for use */
|
|
924
|
+
period?: Period;
|
|
925
|
+
/** Organization that issued id (may be just text) */
|
|
926
|
+
assigner?: Reference;
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* An identifier intended for computation
|
|
931
|
+
* Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)
|
|
932
|
+
*/
|
|
933
|
+
export declare interface IdentifierOutput extends ElementOutput {
|
|
934
|
+
/** usual | official | temp | secondary | old (If known) */
|
|
935
|
+
use?: string;
|
|
936
|
+
/** Description of identifier */
|
|
937
|
+
type?: CodeableConceptOutput;
|
|
938
|
+
/** The namespace for the identifier value */
|
|
939
|
+
system?: string;
|
|
940
|
+
/** The value that is unique */
|
|
941
|
+
value?: string;
|
|
942
|
+
/** Time period when id is/was valid for use */
|
|
943
|
+
period?: PeriodOutput;
|
|
944
|
+
/** Organization that issued id (may be just text) */
|
|
945
|
+
assigner?: ReferenceOutput;
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
/** Imaging procedure. */
|
|
949
|
+
export declare interface ImagingProcedure {
|
|
950
|
+
/** Modality : SNOMED CT code. */
|
|
951
|
+
modality: CodeableConcept;
|
|
952
|
+
/** Anatomy : SNOMED CT code. */
|
|
953
|
+
anatomy: CodeableConcept;
|
|
954
|
+
/** Laterality : SNOMED CT code. */
|
|
955
|
+
laterality?: CodeableConcept;
|
|
956
|
+
/** Contrast : see RadiologyCodeWithTypes (below). */
|
|
957
|
+
contrast?: RadiologyCodeWithTypes;
|
|
958
|
+
/** View : see RadiologyCodeWithTypes (below). */
|
|
959
|
+
view?: RadiologyCodeWithTypes;
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
/** Imaging procedure. */
|
|
963
|
+
export declare interface ImagingProcedureOutput {
|
|
964
|
+
/** Modality : SNOMED CT code. */
|
|
965
|
+
modality: CodeableConceptOutput;
|
|
966
|
+
/** Anatomy : SNOMED CT code. */
|
|
967
|
+
anatomy: CodeableConceptOutput;
|
|
968
|
+
/** Laterality : SNOMED CT code. */
|
|
969
|
+
laterality?: CodeableConceptOutput;
|
|
970
|
+
/** Contrast : see RadiologyCodeWithTypes (below). */
|
|
971
|
+
contrast?: RadiologyCodeWithTypesOutput;
|
|
972
|
+
/** View : see RadiologyCodeWithTypes (below). */
|
|
973
|
+
view?: RadiologyCodeWithTypesOutput;
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
/** Imaging procedures. */
|
|
977
|
+
export declare interface ImagingProcedureRecommendation extends ProcedureRecommendationParent {
|
|
978
|
+
/** Procedure type : imaging. */
|
|
979
|
+
kind: "imagingProcedureRecommendation";
|
|
980
|
+
/** LOINC codes for the procedure. */
|
|
981
|
+
procedureCodes?: Array<CodeableConcept>;
|
|
982
|
+
/** Imaging procedures. */
|
|
983
|
+
imagingProcedures: Array<ImagingProcedure>;
|
|
984
|
+
}
|
|
985
|
+
|
|
986
|
+
/** Imaging procedures. */
|
|
987
|
+
export declare interface ImagingProcedureRecommendationOutput extends ProcedureRecommendationOutputParent {
|
|
988
|
+
/** Procedure type : imaging. */
|
|
989
|
+
kind: "imagingProcedureRecommendation";
|
|
990
|
+
/** LOINC codes for the procedure. */
|
|
991
|
+
procedureCodes?: Array<CodeableConceptOutput>;
|
|
992
|
+
/** Imaging procedures. */
|
|
993
|
+
imagingProcedures: Array<ImagingProcedureOutput>;
|
|
994
|
+
}
|
|
995
|
+
|
|
996
|
+
/** Unexpected responses for get job calls */
|
|
997
|
+
export declare function isUnexpected(response: GetJob200Response | GetJobDefaultResponse): response is GetJobDefaultResponse;
|
|
998
|
+
|
|
999
|
+
/** Unexpected responses for create job calls */
|
|
1000
|
+
export declare function isUnexpected(response: CreateJob200Response | CreateJob201Response | CreateJobLogicalResponse | CreateJobDefaultResponse): response is CreateJobDefaultResponse;
|
|
1001
|
+
|
|
1002
|
+
/** Alias for JobStatus */
|
|
1003
|
+
export declare type JobStatus = string | "notStarted" | "running" | "succeeded" | "failed" | "canceled";
|
|
1004
|
+
|
|
1005
|
+
/** Alias for JobStatusOutput */
|
|
1006
|
+
export declare type JobStatusOutput = string | "notStarted" | "running" | "succeeded" | "failed" | "canceled";
|
|
1007
|
+
|
|
1008
|
+
/** A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing). */
|
|
1009
|
+
export declare interface LateralityDiscrepancyInference extends RadiologyInsightsInferenceParent {
|
|
1010
|
+
/** Inference type. */
|
|
1011
|
+
kind: "lateralityDiscrepancy";
|
|
1012
|
+
/** Laterality indication : SNOMED CT code for laterality qualifier value. */
|
|
1013
|
+
lateralityIndication?: CodeableConcept;
|
|
1014
|
+
/** Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing. */
|
|
1015
|
+
discrepancyType: LateralityDiscrepancyType;
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
/** A laterality mismatch occurs when there is a discrepancy between the clinical documentation and the ordered procedure (orderLateralityMismatch), a contradiction within the clinical document (textLateralityContradiction), or when no laterality is mentioned (textLateralityMissing). */
|
|
1019
|
+
export declare interface LateralityDiscrepancyInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
1020
|
+
/** Inference type. */
|
|
1021
|
+
kind: "lateralityDiscrepancy";
|
|
1022
|
+
/** Laterality indication : SNOMED CT code for laterality qualifier value. */
|
|
1023
|
+
lateralityIndication?: CodeableConceptOutput;
|
|
1024
|
+
/** Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing. */
|
|
1025
|
+
discrepancyType: LateralityDiscrepancyTypeOutput;
|
|
1026
|
+
}
|
|
1027
|
+
|
|
1028
|
+
/** Alias for LateralityDiscrepancyType */
|
|
1029
|
+
export declare type LateralityDiscrepancyType = string | "orderLateralityMismatch" | "textLateralityContradiction" | "textLateralityMissing";
|
|
1030
|
+
|
|
1031
|
+
/** Alias for LateralityDiscrepancyTypeOutput */
|
|
1032
|
+
export declare type LateralityDiscrepancyTypeOutput = string | "orderLateralityMismatch" | "textLateralityContradiction" | "textLateralityMissing";
|
|
1033
|
+
|
|
1034
|
+
/** A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document. */
|
|
1035
|
+
export declare interface LimitedOrderDiscrepancyInference extends RadiologyInsightsInferenceParent {
|
|
1036
|
+
/** Inference type. */
|
|
1037
|
+
kind: "limitedOrderDiscrepancy";
|
|
1038
|
+
/** Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. */
|
|
1039
|
+
orderType: CodeableConcept;
|
|
1040
|
+
/** List of body parts found in the document : SNOMED CT codes. */
|
|
1041
|
+
presentBodyParts?: Array<CodeableConcept>;
|
|
1042
|
+
/** List of body parts that are measured according to the document : SNOMED CT codes. */
|
|
1043
|
+
presentBodyPartMeasurements?: Array<CodeableConcept>;
|
|
1044
|
+
}
|
|
1045
|
+
|
|
1046
|
+
/** A limited order discrepancy occurs when there is a limited order, but all body parts and measurements that are needed for a complete order are present in the document. */
|
|
1047
|
+
export declare interface LimitedOrderDiscrepancyInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
1048
|
+
/** Inference type. */
|
|
1049
|
+
kind: "limitedOrderDiscrepancy";
|
|
1050
|
+
/** Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. */
|
|
1051
|
+
orderType: CodeableConceptOutput;
|
|
1052
|
+
/** List of body parts found in the document : SNOMED CT codes. */
|
|
1053
|
+
presentBodyParts?: Array<CodeableConceptOutput>;
|
|
1054
|
+
/** List of body parts that are measured according to the document : SNOMED CT codes. */
|
|
1055
|
+
presentBodyPartMeasurements?: Array<CodeableConceptOutput>;
|
|
1056
|
+
}
|
|
1057
|
+
|
|
1058
|
+
/** Alias for MedicalProfessionalType */
|
|
1059
|
+
export declare type MedicalProfessionalType = string | "unknown" | "doctor" | "nurse" | "midwife" | "physicianAssistant";
|
|
1060
|
+
|
|
1061
|
+
/** Alias for MedicalProfessionalTypeOutput */
|
|
1062
|
+
export declare type MedicalProfessionalTypeOutput = string | "unknown" | "doctor" | "nurse" | "midwife" | "physicianAssistant";
|
|
1063
|
+
|
|
1064
|
+
/**
|
|
1065
|
+
* Metadata about a resource
|
|
1066
|
+
* Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta)
|
|
1067
|
+
*/
|
|
1068
|
+
export declare interface Meta {
|
|
1069
|
+
/** The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. */
|
|
1070
|
+
versionId?: string;
|
|
1071
|
+
/** When the resource last changed - e.g. when the version changed. */
|
|
1072
|
+
lastUpdated?: string;
|
|
1073
|
+
/** A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. */
|
|
1074
|
+
source?: string;
|
|
1075
|
+
/** A list of profiles (references to [StructureDefinition](https://www.hl7.org/fhir/structuredefinition.html) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](https://www.hl7.org/fhir/structuredefinition-definitions.html#StructureDefinition.url). */
|
|
1076
|
+
profile?: string[];
|
|
1077
|
+
/** Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. */
|
|
1078
|
+
security?: Array<Coding>;
|
|
1079
|
+
/** Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. */
|
|
1080
|
+
tag?: Array<Coding>;
|
|
1081
|
+
}
|
|
1082
|
+
|
|
1083
|
+
/**
|
|
1084
|
+
* Metadata about a resource
|
|
1085
|
+
* Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta)
|
|
1086
|
+
*/
|
|
1087
|
+
export declare interface MetaOutput {
|
|
1088
|
+
/** The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. */
|
|
1089
|
+
versionId?: string;
|
|
1090
|
+
/** When the resource last changed - e.g. when the version changed. */
|
|
1091
|
+
lastUpdated?: string;
|
|
1092
|
+
/** A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. */
|
|
1093
|
+
source?: string;
|
|
1094
|
+
/** A list of profiles (references to [StructureDefinition](https://www.hl7.org/fhir/structuredefinition.html) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](https://www.hl7.org/fhir/structuredefinition-definitions.html#StructureDefinition.url). */
|
|
1095
|
+
profile?: string[];
|
|
1096
|
+
/** Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. */
|
|
1097
|
+
security?: Array<CodingOutput>;
|
|
1098
|
+
/** Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. */
|
|
1099
|
+
tag?: Array<CodingOutput>;
|
|
1100
|
+
}
|
|
1101
|
+
|
|
1102
|
+
/**
|
|
1103
|
+
* Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human.
|
|
1104
|
+
* Based on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative)
|
|
1105
|
+
*/
|
|
1106
|
+
export declare interface Narrative extends Element {
|
|
1107
|
+
/** generated, extensions, additional, empty */
|
|
1108
|
+
status: string;
|
|
1109
|
+
/** xhtml */
|
|
1110
|
+
div: string;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
/**
|
|
1114
|
+
* Any resource that is a [DomainResource](https://www.hl7.org/fhir/domainresource.html) may include a human-readable narrative that contains a summary of the resource and may be used to represent the content of the resource to a human.
|
|
1115
|
+
* Based on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative)
|
|
1116
|
+
*/
|
|
1117
|
+
export declare interface NarrativeOutput extends ElementOutput {
|
|
1118
|
+
/** generated, extensions, additional, empty */
|
|
1119
|
+
status: string;
|
|
1120
|
+
/** xhtml */
|
|
1121
|
+
div: string;
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
/**
|
|
1125
|
+
* Detailed information about observations
|
|
1126
|
+
* Based on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html)
|
|
1127
|
+
*/
|
|
1128
|
+
export declare interface Observation extends DomainResourceParent {
|
|
1129
|
+
/** resourceType */
|
|
1130
|
+
resourceType: "Observation";
|
|
1131
|
+
/** Business Identifier for observation */
|
|
1132
|
+
identifier?: Array<Identifier>;
|
|
1133
|
+
/** registered | preliminary | final | amended + */
|
|
1134
|
+
status: ObservationStatusCodeType;
|
|
1135
|
+
/** Classification of type of observation */
|
|
1136
|
+
category?: Array<CodeableConcept>;
|
|
1137
|
+
/** Type of observation (code / type) */
|
|
1138
|
+
code: CodeableConcept;
|
|
1139
|
+
/** Who and/or what the observation is about */
|
|
1140
|
+
subject?: Reference;
|
|
1141
|
+
/** Healthcare event during which this observation is made */
|
|
1142
|
+
encounter?: Reference;
|
|
1143
|
+
/** Clinically relevant time/time-period for observation */
|
|
1144
|
+
effectiveDateTime?: string;
|
|
1145
|
+
/** Clinically relevant time/time-period for observation */
|
|
1146
|
+
effectivePeriod?: Period;
|
|
1147
|
+
/** Clinically relevant time/time-period for observation */
|
|
1148
|
+
effectiveInstant?: string;
|
|
1149
|
+
/** Date/Time this version was made available */
|
|
1150
|
+
issued?: string;
|
|
1151
|
+
/** Actual result */
|
|
1152
|
+
valueQuantity?: Quantity;
|
|
1153
|
+
/** Actual result */
|
|
1154
|
+
valueCodeableConcept?: CodeableConcept;
|
|
1155
|
+
/** Actual result */
|
|
1156
|
+
valueString?: string;
|
|
1157
|
+
/** Actual result */
|
|
1158
|
+
valueBoolean?: boolean;
|
|
1159
|
+
/** Actual result */
|
|
1160
|
+
valueInteger?: number;
|
|
1161
|
+
/** Actual result */
|
|
1162
|
+
valueRange?: Range;
|
|
1163
|
+
/** Actual result */
|
|
1164
|
+
valueRatio?: Ratio;
|
|
1165
|
+
/** Actual result */
|
|
1166
|
+
valueSampledData?: SampledData;
|
|
1167
|
+
/** Actual result */
|
|
1168
|
+
valueTime?: Date | string;
|
|
1169
|
+
/** Actual result */
|
|
1170
|
+
valueDateTime?: string;
|
|
1171
|
+
/** Actual result */
|
|
1172
|
+
valuePeriod?: Period;
|
|
1173
|
+
/** Why the result is missing */
|
|
1174
|
+
dataAbsentReason?: CodeableConcept;
|
|
1175
|
+
/** High, low, normal, etc. */
|
|
1176
|
+
interpretation?: Array<CodeableConcept>;
|
|
1177
|
+
/** Comments about the observation */
|
|
1178
|
+
note?: Array<Annotation>;
|
|
1179
|
+
/** Observed body part */
|
|
1180
|
+
bodySite?: CodeableConcept;
|
|
1181
|
+
/** How it was done */
|
|
1182
|
+
method?: CodeableConcept;
|
|
1183
|
+
/** Provides guide for interpretation */
|
|
1184
|
+
referenceRange?: Array<ObservationReferenceRange>;
|
|
1185
|
+
/** Related resource that belongs to the Observation group */
|
|
1186
|
+
hasMember?: Array<Reference>;
|
|
1187
|
+
/** Related measurements the observation is made from */
|
|
1188
|
+
derivedFrom?: Array<Reference>;
|
|
1189
|
+
/** Component results */
|
|
1190
|
+
component?: Array<ObservationComponent>;
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
/**
|
|
1194
|
+
* Component results
|
|
1195
|
+
* Based on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html)
|
|
1196
|
+
*/
|
|
1197
|
+
export declare interface ObservationComponent extends Element {
|
|
1198
|
+
/** Type of component observation (code / type) */
|
|
1199
|
+
code: CodeableConcept;
|
|
1200
|
+
/** Value as Quantity */
|
|
1201
|
+
valueQuantity?: Quantity;
|
|
1202
|
+
/** Value as CodeableConcept */
|
|
1203
|
+
valueCodeableConcept?: CodeableConcept;
|
|
1204
|
+
/** Value as string */
|
|
1205
|
+
valueString?: string;
|
|
1206
|
+
/** Value as boolean */
|
|
1207
|
+
valueBoolean?: boolean;
|
|
1208
|
+
/** Value as integer */
|
|
1209
|
+
valueInteger?: number;
|
|
1210
|
+
/** Value as Range. */
|
|
1211
|
+
valueRange?: Range;
|
|
1212
|
+
/** Value as Ratio. */
|
|
1213
|
+
valueRatio?: Ratio;
|
|
1214
|
+
/** Value as SampledData. */
|
|
1215
|
+
valueSampledData?: SampledData;
|
|
1216
|
+
/** Value as time (hh:mm:ss) */
|
|
1217
|
+
valueTime?: Date | string;
|
|
1218
|
+
/** Value as dateTime. */
|
|
1219
|
+
valueDateTime?: string;
|
|
1220
|
+
/** Value as Period. */
|
|
1221
|
+
valuePeriod?: Period;
|
|
1222
|
+
/** Value as reference. */
|
|
1223
|
+
valueReference?: Reference;
|
|
1224
|
+
/** Why the component result is missing */
|
|
1225
|
+
dataAbsentReason?: CodeableConcept;
|
|
1226
|
+
/** High, low, normal, etc. */
|
|
1227
|
+
interpretation?: Array<CodeableConcept>;
|
|
1228
|
+
/** Provides guide for interpretation of component result */
|
|
1229
|
+
referenceRange?: Array<ObservationReferenceRange>;
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1232
|
+
/**
|
|
1233
|
+
* Component results
|
|
1234
|
+
* Based on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html)
|
|
1235
|
+
*/
|
|
1236
|
+
export declare interface ObservationComponentOutput extends ElementOutput {
|
|
1237
|
+
/** Type of component observation (code / type) */
|
|
1238
|
+
code: CodeableConceptOutput;
|
|
1239
|
+
/** Value as Quantity */
|
|
1240
|
+
valueQuantity?: QuantityOutput;
|
|
1241
|
+
/** Value as CodeableConcept */
|
|
1242
|
+
valueCodeableConcept?: CodeableConceptOutput;
|
|
1243
|
+
/** Value as string */
|
|
1244
|
+
valueString?: string;
|
|
1245
|
+
/** Value as boolean */
|
|
1246
|
+
valueBoolean?: boolean;
|
|
1247
|
+
/** Value as integer */
|
|
1248
|
+
valueInteger?: number;
|
|
1249
|
+
/** Value as Range. */
|
|
1250
|
+
valueRange?: RangeOutput;
|
|
1251
|
+
/** Value as Ratio. */
|
|
1252
|
+
valueRatio?: RatioOutput;
|
|
1253
|
+
/** Value as SampledData. */
|
|
1254
|
+
valueSampledData?: SampledDataOutput;
|
|
1255
|
+
/** Value as time (hh:mm:ss) */
|
|
1256
|
+
valueTime?: string;
|
|
1257
|
+
/** Value as dateTime. */
|
|
1258
|
+
valueDateTime?: string;
|
|
1259
|
+
/** Value as Period. */
|
|
1260
|
+
valuePeriod?: PeriodOutput;
|
|
1261
|
+
/** Value as reference. */
|
|
1262
|
+
valueReference?: ReferenceOutput;
|
|
1263
|
+
/** Why the component result is missing */
|
|
1264
|
+
dataAbsentReason?: CodeableConceptOutput;
|
|
1265
|
+
/** High, low, normal, etc. */
|
|
1266
|
+
interpretation?: Array<CodeableConceptOutput>;
|
|
1267
|
+
/** Provides guide for interpretation of component result */
|
|
1268
|
+
referenceRange?: Array<ObservationReferenceRangeOutput>;
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
* Detailed information about observations
|
|
1273
|
+
* Based on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html)
|
|
1274
|
+
*/
|
|
1275
|
+
export declare interface ObservationOutput extends DomainResourceOutputParent {
|
|
1276
|
+
/** resourceType */
|
|
1277
|
+
resourceType: "Observation";
|
|
1278
|
+
/** Business Identifier for observation */
|
|
1279
|
+
identifier?: Array<IdentifierOutput>;
|
|
1280
|
+
/** registered | preliminary | final | amended + */
|
|
1281
|
+
status: ObservationStatusCodeTypeOutput;
|
|
1282
|
+
/** Classification of type of observation */
|
|
1283
|
+
category?: Array<CodeableConceptOutput>;
|
|
1284
|
+
/** Type of observation (code / type) */
|
|
1285
|
+
code: CodeableConceptOutput;
|
|
1286
|
+
/** Who and/or what the observation is about */
|
|
1287
|
+
subject?: ReferenceOutput;
|
|
1288
|
+
/** Healthcare event during which this observation is made */
|
|
1289
|
+
encounter?: ReferenceOutput;
|
|
1290
|
+
/** Clinically relevant time/time-period for observation */
|
|
1291
|
+
effectiveDateTime?: string;
|
|
1292
|
+
/** Clinically relevant time/time-period for observation */
|
|
1293
|
+
effectivePeriod?: PeriodOutput;
|
|
1294
|
+
/** Clinically relevant time/time-period for observation */
|
|
1295
|
+
effectiveInstant?: string;
|
|
1296
|
+
/** Date/Time this version was made available */
|
|
1297
|
+
issued?: string;
|
|
1298
|
+
/** Actual result */
|
|
1299
|
+
valueQuantity?: QuantityOutput;
|
|
1300
|
+
/** Actual result */
|
|
1301
|
+
valueCodeableConcept?: CodeableConceptOutput;
|
|
1302
|
+
/** Actual result */
|
|
1303
|
+
valueString?: string;
|
|
1304
|
+
/** Actual result */
|
|
1305
|
+
valueBoolean?: boolean;
|
|
1306
|
+
/** Actual result */
|
|
1307
|
+
valueInteger?: number;
|
|
1308
|
+
/** Actual result */
|
|
1309
|
+
valueRange?: RangeOutput;
|
|
1310
|
+
/** Actual result */
|
|
1311
|
+
valueRatio?: RatioOutput;
|
|
1312
|
+
/** Actual result */
|
|
1313
|
+
valueSampledData?: SampledDataOutput;
|
|
1314
|
+
/** Actual result */
|
|
1315
|
+
valueTime?: string;
|
|
1316
|
+
/** Actual result */
|
|
1317
|
+
valueDateTime?: string;
|
|
1318
|
+
/** Actual result */
|
|
1319
|
+
valuePeriod?: PeriodOutput;
|
|
1320
|
+
/** Why the result is missing */
|
|
1321
|
+
dataAbsentReason?: CodeableConceptOutput;
|
|
1322
|
+
/** High, low, normal, etc. */
|
|
1323
|
+
interpretation?: Array<CodeableConceptOutput>;
|
|
1324
|
+
/** Comments about the observation */
|
|
1325
|
+
note?: Array<AnnotationOutput>;
|
|
1326
|
+
/** Observed body part */
|
|
1327
|
+
bodySite?: CodeableConceptOutput;
|
|
1328
|
+
/** How it was done */
|
|
1329
|
+
method?: CodeableConceptOutput;
|
|
1330
|
+
/** Provides guide for interpretation */
|
|
1331
|
+
referenceRange?: Array<ObservationReferenceRangeOutput>;
|
|
1332
|
+
/** Related resource that belongs to the Observation group */
|
|
1333
|
+
hasMember?: Array<ReferenceOutput>;
|
|
1334
|
+
/** Related measurements the observation is made from */
|
|
1335
|
+
derivedFrom?: Array<ReferenceOutput>;
|
|
1336
|
+
/** Component results */
|
|
1337
|
+
component?: Array<ObservationComponentOutput>;
|
|
1338
|
+
}
|
|
1339
|
+
|
|
1340
|
+
/**
|
|
1341
|
+
* Provides guide for interpretation of component result
|
|
1342
|
+
* Based on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html)
|
|
1343
|
+
*/
|
|
1344
|
+
export declare interface ObservationReferenceRange {
|
|
1345
|
+
/** Low Range, if relevant */
|
|
1346
|
+
low?: Quantity;
|
|
1347
|
+
/** High Range, if relevant */
|
|
1348
|
+
high?: Quantity;
|
|
1349
|
+
/** Reference range qualifier */
|
|
1350
|
+
type?: CodeableConcept;
|
|
1351
|
+
/** Reference range population */
|
|
1352
|
+
appliesTo?: Array<CodeableConcept>;
|
|
1353
|
+
/** Applicable age range, if relevant */
|
|
1354
|
+
age?: Range;
|
|
1355
|
+
/** Text based reference range in an observation */
|
|
1356
|
+
text?: string;
|
|
1357
|
+
}
|
|
1358
|
+
|
|
1359
|
+
/**
|
|
1360
|
+
* Provides guide for interpretation of component result
|
|
1361
|
+
* Based on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html)
|
|
1362
|
+
*/
|
|
1363
|
+
export declare interface ObservationReferenceRangeOutput {
|
|
1364
|
+
/** Low Range, if relevant */
|
|
1365
|
+
low?: QuantityOutput;
|
|
1366
|
+
/** High Range, if relevant */
|
|
1367
|
+
high?: QuantityOutput;
|
|
1368
|
+
/** Reference range qualifier */
|
|
1369
|
+
type?: CodeableConceptOutput;
|
|
1370
|
+
/** Reference range population */
|
|
1371
|
+
appliesTo?: Array<CodeableConceptOutput>;
|
|
1372
|
+
/** Applicable age range, if relevant */
|
|
1373
|
+
age?: RangeOutput;
|
|
1374
|
+
/** Text based reference range in an observation */
|
|
1375
|
+
text?: string;
|
|
1376
|
+
}
|
|
1377
|
+
|
|
1378
|
+
/** Alias for ObservationStatusCodeType */
|
|
1379
|
+
export declare type ObservationStatusCodeType = string | "registered" | "preliminary" | "final" | "amended" | "corrected" | "cancelled" | "entered-in-error" | "unknown";
|
|
1380
|
+
|
|
1381
|
+
/** Alias for ObservationStatusCodeTypeOutput */
|
|
1382
|
+
export declare type ObservationStatusCodeTypeOutput = string | "registered" | "preliminary" | "final" | "amended" | "corrected" | "cancelled" | "entered-in-error" | "unknown";
|
|
1383
|
+
|
|
1384
|
+
/** Procedure information */
|
|
1385
|
+
export declare interface OrderedProcedure {
|
|
1386
|
+
/** Procedure code */
|
|
1387
|
+
code?: CodeableConcept;
|
|
1388
|
+
/** Procedure description */
|
|
1389
|
+
description?: string;
|
|
1390
|
+
/** Additional Content defined by implementations */
|
|
1391
|
+
extension?: Array<Extension>;
|
|
1392
|
+
}
|
|
1393
|
+
|
|
1394
|
+
/** Procedure information */
|
|
1395
|
+
export declare interface OrderedProcedureOutput {
|
|
1396
|
+
/** Procedure code */
|
|
1397
|
+
code?: CodeableConceptOutput;
|
|
1398
|
+
/** Procedure description */
|
|
1399
|
+
description?: string;
|
|
1400
|
+
/** Additional Content defined by implementations */
|
|
1401
|
+
extension?: Array<ExtensionOutput>;
|
|
1402
|
+
}
|
|
1403
|
+
|
|
1404
|
+
/** Patient structured information, including demographics and known structured clinical information. */
|
|
1405
|
+
export declare interface PatientDetails {
|
|
1406
|
+
/** The patient's sex. */
|
|
1407
|
+
sex?: PatientSex;
|
|
1408
|
+
/** The patient's date of birth. */
|
|
1409
|
+
birthDate?: Date | string;
|
|
1410
|
+
/** Known clinical information for the patient, structured. */
|
|
1411
|
+
clinicalInfo?: Array<Resource>;
|
|
1412
|
+
}
|
|
1413
|
+
|
|
1414
|
+
/** Patient structured information, including demographics and known structured clinical information. */
|
|
1415
|
+
export declare interface PatientDetailsOutput {
|
|
1416
|
+
/** The patient's sex. */
|
|
1417
|
+
sex?: PatientSexOutput;
|
|
1418
|
+
/** The patient's date of birth. */
|
|
1419
|
+
birthDate?: string;
|
|
1420
|
+
/** Known clinical information for the patient, structured. */
|
|
1421
|
+
clinicalInfo?: Array<ResourceOutput>;
|
|
1422
|
+
}
|
|
1423
|
+
|
|
1424
|
+
/** A clinical document related to a patient. Document here is in the wide sense - not just a text document (note). */
|
|
1425
|
+
export declare interface PatientDocument {
|
|
1426
|
+
/** The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document). */
|
|
1427
|
+
type: DocumentType;
|
|
1428
|
+
/** The type of the clinical document. */
|
|
1429
|
+
clinicalType?: ClinicalDocumentType;
|
|
1430
|
+
/** A given identifier for the document. Has to be unique across all documents for a single patient. */
|
|
1431
|
+
id: string;
|
|
1432
|
+
/** A 2 letter ISO 639-1 representation of the language of the document. */
|
|
1433
|
+
language?: string;
|
|
1434
|
+
/** The date and time when the document was created. */
|
|
1435
|
+
createdAt?: Date | string;
|
|
1436
|
+
/** Document author(s) */
|
|
1437
|
+
authors?: Array<DocumentAuthor>;
|
|
1438
|
+
/** specialty type the document */
|
|
1439
|
+
specialtyType?: SpecialtyType;
|
|
1440
|
+
/** Administrative metadata for the document. */
|
|
1441
|
+
administrativeMetadata?: DocumentAdministrativeMetadata;
|
|
1442
|
+
/** The content of the patient document. */
|
|
1443
|
+
content: DocumentContent;
|
|
1444
|
+
}
|
|
1445
|
+
|
|
1446
|
+
/** A clinical document related to a patient. Document here is in the wide sense - not just a text document (note). */
|
|
1447
|
+
export declare interface PatientDocumentOutput {
|
|
1448
|
+
/** The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document). */
|
|
1449
|
+
type: DocumentTypeOutput;
|
|
1450
|
+
/** The type of the clinical document. */
|
|
1451
|
+
clinicalType?: ClinicalDocumentTypeOutput;
|
|
1452
|
+
/** A given identifier for the document. Has to be unique across all documents for a single patient. */
|
|
1453
|
+
id: string;
|
|
1454
|
+
/** A 2 letter ISO 639-1 representation of the language of the document. */
|
|
1455
|
+
language?: string;
|
|
1456
|
+
/** The date and time when the document was created. */
|
|
1457
|
+
createdAt?: string;
|
|
1458
|
+
/** Document author(s) */
|
|
1459
|
+
authors?: Array<DocumentAuthorOutput>;
|
|
1460
|
+
/** specialty type the document */
|
|
1461
|
+
specialtyType?: SpecialtyTypeOutput;
|
|
1462
|
+
/** Administrative metadata for the document. */
|
|
1463
|
+
administrativeMetadata?: DocumentAdministrativeMetadataOutput;
|
|
1464
|
+
/** The content of the patient document. */
|
|
1465
|
+
content: DocumentContentOutput;
|
|
1466
|
+
}
|
|
1467
|
+
|
|
1468
|
+
/** visit/encounter information */
|
|
1469
|
+
export declare interface PatientEncounter {
|
|
1470
|
+
/** The id of the visit. */
|
|
1471
|
+
id: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* Time period of the visit.
|
|
1474
|
+
* In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time.
|
|
1475
|
+
*/
|
|
1476
|
+
period?: TimePeriod;
|
|
1477
|
+
/** The class of the encounter. */
|
|
1478
|
+
class?: EncounterClass;
|
|
1479
|
+
}
|
|
1480
|
+
|
|
1481
|
+
/** visit/encounter information */
|
|
1482
|
+
export declare interface PatientEncounterOutput {
|
|
1483
|
+
/** The id of the visit. */
|
|
1484
|
+
id: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Time period of the visit.
|
|
1487
|
+
* In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time.
|
|
1488
|
+
*/
|
|
1489
|
+
period?: TimePeriodOutput;
|
|
1490
|
+
/** The class of the encounter. */
|
|
1491
|
+
class?: EncounterClassOutput;
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1494
|
+
/** A patient record, including their clinical information and data. */
|
|
1495
|
+
export declare interface PatientRecord {
|
|
1496
|
+
/** A given identifier for the patient. Has to be unique across all patients in a single request. */
|
|
1497
|
+
id: string;
|
|
1498
|
+
/** Patient structured information, including demographics and known structured clinical information. */
|
|
1499
|
+
details?: PatientDetails;
|
|
1500
|
+
/** Patient encounters/visits. */
|
|
1501
|
+
encounters?: Array<PatientEncounter>;
|
|
1502
|
+
/** Patient unstructured clinical data, given as documents. */
|
|
1503
|
+
patientDocuments?: Array<PatientDocument>;
|
|
1504
|
+
}
|
|
1505
|
+
|
|
1506
|
+
/** A patient record, including their clinical information and data. */
|
|
1507
|
+
export declare interface PatientRecordOutput {
|
|
1508
|
+
/** A given identifier for the patient. Has to be unique across all patients in a single request. */
|
|
1509
|
+
id: string;
|
|
1510
|
+
/** Patient structured information, including demographics and known structured clinical information. */
|
|
1511
|
+
details?: PatientDetailsOutput;
|
|
1512
|
+
/** Patient encounters/visits. */
|
|
1513
|
+
encounters?: Array<PatientEncounterOutput>;
|
|
1514
|
+
/** Patient unstructured clinical data, given as documents. */
|
|
1515
|
+
patientDocuments?: Array<PatientDocumentOutput>;
|
|
1516
|
+
}
|
|
1517
|
+
|
|
1518
|
+
/** Alias for PatientSex */
|
|
1519
|
+
export declare type PatientSex = string | "female" | "male" | "unspecified";
|
|
1520
|
+
|
|
1521
|
+
/** Alias for PatientSexOutput */
|
|
1522
|
+
export declare type PatientSexOutput = string | "female" | "male" | "unspecified";
|
|
1523
|
+
|
|
1524
|
+
/**
|
|
1525
|
+
* A time period defined by a start and end date and optionally time
|
|
1526
|
+
* Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period)
|
|
1527
|
+
*/
|
|
1528
|
+
export declare interface Period extends Element {
|
|
1529
|
+
/** Starting time with inclusive boundary */
|
|
1530
|
+
start?: string;
|
|
1531
|
+
/** End time with inclusive boundary, if not ongoing */
|
|
1532
|
+
end?: string;
|
|
1533
|
+
}
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* A time period defined by a start and end date and optionally time
|
|
1537
|
+
* Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period)
|
|
1538
|
+
*/
|
|
1539
|
+
export declare interface PeriodOutput extends ElementOutput {
|
|
1540
|
+
/** Starting time with inclusive boundary */
|
|
1541
|
+
start?: string;
|
|
1542
|
+
/** End time with inclusive boundary, if not ongoing */
|
|
1543
|
+
end?: string;
|
|
1544
|
+
}
|
|
1545
|
+
|
|
1546
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
1547
|
+
export declare type ProcedureRecommendation = ProcedureRecommendationParent | GenericProcedureRecommendation | ImagingProcedureRecommendation;
|
|
1548
|
+
|
|
1549
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
1550
|
+
export declare type ProcedureRecommendationOutput = ProcedureRecommendationOutputParent | GenericProcedureRecommendationOutput | ImagingProcedureRecommendationOutput;
|
|
1551
|
+
|
|
1552
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
1553
|
+
export declare interface ProcedureRecommendationOutputParent {
|
|
1554
|
+
/** Additional Content defined by implementations */
|
|
1555
|
+
extension?: Array<ExtensionOutput>;
|
|
1556
|
+
/** The kind of procedure recommendation eg. generic or imaging*/
|
|
1557
|
+
kind: string;
|
|
1558
|
+
}
|
|
1559
|
+
|
|
1560
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
1561
|
+
export declare interface ProcedureRecommendationParent {
|
|
1562
|
+
/** Additional Content defined by implementations */
|
|
1563
|
+
extension?: Array<Extension>;
|
|
1564
|
+
/** The kind of procedure recommendation eg. generic or imaging*/
|
|
1565
|
+
kind: string;
|
|
1566
|
+
}
|
|
1567
|
+
|
|
1568
|
+
/**
|
|
1569
|
+
* A measured or measurable amount
|
|
1570
|
+
* Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity)
|
|
1571
|
+
*/
|
|
1572
|
+
export declare interface Quantity extends Element {
|
|
1573
|
+
/** Numerical value (with implicit precision) */
|
|
1574
|
+
value?: number;
|
|
1575
|
+
/** \< | \<= | \>= | \> - how to understand the value */
|
|
1576
|
+
comparator?: string;
|
|
1577
|
+
/** Unit representation */
|
|
1578
|
+
unit?: string;
|
|
1579
|
+
/** System that defines coded unit form */
|
|
1580
|
+
system?: string;
|
|
1581
|
+
/** Coded form of the unit */
|
|
1582
|
+
code?: string;
|
|
1583
|
+
}
|
|
1584
|
+
|
|
1585
|
+
/**
|
|
1586
|
+
* A measured or measurable amount
|
|
1587
|
+
* Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity)
|
|
1588
|
+
*/
|
|
1589
|
+
export declare interface QuantityOutput extends ElementOutput {
|
|
1590
|
+
/** Numerical value (with implicit precision) */
|
|
1591
|
+
value?: number;
|
|
1592
|
+
/** \< | \<= | \>= | \> - how to understand the value */
|
|
1593
|
+
comparator?: string;
|
|
1594
|
+
/** Unit representation */
|
|
1595
|
+
unit?: string;
|
|
1596
|
+
/** System that defines coded unit form */
|
|
1597
|
+
system?: string;
|
|
1598
|
+
/** Coded form of the unit */
|
|
1599
|
+
code?: string;
|
|
1600
|
+
}
|
|
1601
|
+
|
|
1602
|
+
/** Radiology code with types : used in imaging procedure recommendation for contrast and view. */
|
|
1603
|
+
export declare interface RadiologyCodeWithTypes {
|
|
1604
|
+
/** The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views. */
|
|
1605
|
+
code: CodeableConcept;
|
|
1606
|
+
/** The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc. */
|
|
1607
|
+
types: Array<CodeableConcept>;
|
|
1608
|
+
}
|
|
1609
|
+
|
|
1610
|
+
/** Radiology code with types : used in imaging procedure recommendation for contrast and view. */
|
|
1611
|
+
export declare interface RadiologyCodeWithTypesOutput {
|
|
1612
|
+
/** The SNOMED CT code indicates whether imaging was conducted with or without contrast in the case of contrast, and in the case of views, it denotes the number of views. */
|
|
1613
|
+
code: CodeableConceptOutput;
|
|
1614
|
+
/** The collection of types will indicate the contrast substance used in the case of contrast and, in the case of views, it will specify the types of views, such as lateral and frontal, etc. */
|
|
1615
|
+
types: Array<CodeableConceptOutput>;
|
|
1616
|
+
}
|
|
1617
|
+
|
|
1618
|
+
/** Contains the list of patients, and configuration data. */
|
|
1619
|
+
export declare interface RadiologyInsightsData {
|
|
1620
|
+
/** The list of patients, including their clinical information and data. */
|
|
1621
|
+
patients: Array<PatientRecord>;
|
|
1622
|
+
/** Configuration affecting the Radiology Insights model's inference. */
|
|
1623
|
+
configuration?: RadiologyInsightsModelConfiguration;
|
|
1624
|
+
}
|
|
1625
|
+
|
|
1626
|
+
/** Contains the list of patients, and configuration data. */
|
|
1627
|
+
export declare interface RadiologyInsightsDataOutput {
|
|
1628
|
+
/** The list of patients, including their clinical information and data. */
|
|
1629
|
+
patients: Array<PatientRecordOutput>;
|
|
1630
|
+
/** Configuration affecting the Radiology Insights model's inference. */
|
|
1631
|
+
configuration?: RadiologyInsightsModelConfigurationOutput;
|
|
1632
|
+
}
|
|
1633
|
+
|
|
1634
|
+
/**
|
|
1635
|
+
* An inference made by the Radiology Insights model regarding a patient.
|
|
1636
|
+
* - AgeMismatch
|
|
1637
|
+
* - SexMismatch
|
|
1638
|
+
* - LateralityDiscrepancy
|
|
1639
|
+
* - CompleteOrderDiscrepancy
|
|
1640
|
+
* - LimitedOrderDiscrepancy
|
|
1641
|
+
* - Finding
|
|
1642
|
+
* - CriticalResult
|
|
1643
|
+
* - FollowupRecommendation
|
|
1644
|
+
* - RadiologyProcedure
|
|
1645
|
+
* - FollowupCommunication
|
|
1646
|
+
*/
|
|
1647
|
+
export declare type RadiologyInsightsInference = RadiologyInsightsInferenceParent | AgeMismatchInference | SexMismatchInference | LateralityDiscrepancyInference | CompleteOrderDiscrepancyInference | LimitedOrderDiscrepancyInference | FindingInference | CriticalResultInference | RadiologyProcedureInference | FollowupRecommendationInference | FollowupCommunicationInference;
|
|
1648
|
+
|
|
1649
|
+
/** Options regarding follow up recommendation inferences and finding inferences. */
|
|
1650
|
+
export declare interface RadiologyInsightsInferenceOptions {
|
|
1651
|
+
/** Follow-up recommendation options. */
|
|
1652
|
+
followupRecommendationOptions?: FollowupRecommendationOptions;
|
|
1653
|
+
/** Finding options. */
|
|
1654
|
+
findingOptions?: FindingOptions;
|
|
1655
|
+
}
|
|
1656
|
+
|
|
1657
|
+
/** Options regarding follow up recommendation inferences and finding inferences. */
|
|
1658
|
+
export declare interface RadiologyInsightsInferenceOptionsOutput {
|
|
1659
|
+
/** Follow-up recommendation options. */
|
|
1660
|
+
followupRecommendationOptions?: FollowupRecommendationOptionsOutput;
|
|
1661
|
+
/** Finding options. */
|
|
1662
|
+
findingOptions?: FindingOptionsOutput;
|
|
1663
|
+
}
|
|
1664
|
+
|
|
1665
|
+
/**
|
|
1666
|
+
* An inference made by the Radiology Insights model regarding a patient.
|
|
1667
|
+
* - AgeMismatch
|
|
1668
|
+
* - SexMismatch
|
|
1669
|
+
* - LateralityDiscrepancy
|
|
1670
|
+
* - CompleteOrderDiscrepancy
|
|
1671
|
+
* - LimitedOrderDiscrepancy
|
|
1672
|
+
* - Finding
|
|
1673
|
+
* - CriticalResult
|
|
1674
|
+
* - FollowupRecommendation
|
|
1675
|
+
* - RadiologyProcedure
|
|
1676
|
+
* - FollowupCommunication
|
|
1677
|
+
*/
|
|
1678
|
+
export declare type RadiologyInsightsInferenceOutput = RadiologyInsightsInferenceOutputParent | AgeMismatchInferenceOutput | SexMismatchInferenceOutput | LateralityDiscrepancyInferenceOutput | CompleteOrderDiscrepancyInferenceOutput | LimitedOrderDiscrepancyInferenceOutput | FindingInferenceOutput | CriticalResultInferenceOutput | RadiologyProcedureInferenceOutput | FollowupRecommendationInferenceOutput | FollowupCommunicationInferenceOutput;
|
|
1679
|
+
|
|
1680
|
+
/**
|
|
1681
|
+
* An inference made by the Radiology Insights model regarding a patient.
|
|
1682
|
+
* - AgeMismatch
|
|
1683
|
+
* - SexMismatch
|
|
1684
|
+
* - LateralityDiscrepancy
|
|
1685
|
+
* - CompleteOrderDiscrepancy
|
|
1686
|
+
* - LimitedOrderDiscrepancy
|
|
1687
|
+
* - Finding
|
|
1688
|
+
* - CriticalResult
|
|
1689
|
+
* - FollowupRecommendation
|
|
1690
|
+
* - RadiologyProcedure
|
|
1691
|
+
* - FollowupCommunication
|
|
1692
|
+
*/
|
|
1693
|
+
export declare interface RadiologyInsightsInferenceOutputParent {
|
|
1694
|
+
/** Additional Content defined by implementations */
|
|
1695
|
+
extension?: Array<ExtensionOutput>;
|
|
1696
|
+
/** The kind of inference */
|
|
1697
|
+
kind: string;
|
|
1698
|
+
}
|
|
1699
|
+
|
|
1700
|
+
/**
|
|
1701
|
+
* An inference made by the Radiology Insights model regarding a patient.
|
|
1702
|
+
* - AgeMismatch
|
|
1703
|
+
* - SexMismatch
|
|
1704
|
+
* - LateralityDiscrepancy
|
|
1705
|
+
* - CompleteOrderDiscrepancy
|
|
1706
|
+
* - LimitedOrderDiscrepancy
|
|
1707
|
+
* - Finding
|
|
1708
|
+
* - CriticalResult
|
|
1709
|
+
* - FollowupRecommendation
|
|
1710
|
+
* - RadiologyProcedure
|
|
1711
|
+
* - FollowupCommunication
|
|
1712
|
+
*/
|
|
1713
|
+
export declare interface RadiologyInsightsInferenceParent {
|
|
1714
|
+
/** Additional Content defined by implementations */
|
|
1715
|
+
extension?: Array<Extension>;
|
|
1716
|
+
/** The kind of inference */
|
|
1717
|
+
kind: string;
|
|
1718
|
+
}
|
|
1719
|
+
|
|
1720
|
+
/** The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult. */
|
|
1721
|
+
export declare interface RadiologyInsightsInferenceResult {
|
|
1722
|
+
/** Results for the patients given in the request. */
|
|
1723
|
+
patientResults: Array<RadiologyInsightsPatientResult>;
|
|
1724
|
+
/** The version of the model used for inference, expressed as the model date. */
|
|
1725
|
+
modelVersion: string;
|
|
1726
|
+
}
|
|
1727
|
+
|
|
1728
|
+
/** The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult. */
|
|
1729
|
+
export declare interface RadiologyInsightsInferenceResultOutput {
|
|
1730
|
+
/** Results for the patients given in the request. */
|
|
1731
|
+
patientResults: Array<RadiologyInsightsPatientResultOutput>;
|
|
1732
|
+
/** The version of the model used for inference, expressed as the model date. */
|
|
1733
|
+
modelVersion: string;
|
|
1734
|
+
}
|
|
1735
|
+
|
|
1736
|
+
/** Alias for RadiologyInsightsInferenceType */
|
|
1737
|
+
export declare type RadiologyInsightsInferenceType = string | "ageMismatch" | "lateralityDiscrepancy" | "sexMismatch" | "completeOrderDiscrepancy" | "limitedOrderDiscrepancy" | "finding" | "criticalResult" | "followupRecommendation" | "followupCommunication" | "radiologyProcedure";
|
|
1738
|
+
|
|
1739
|
+
/** Alias for RadiologyInsightsInferenceTypeOutput */
|
|
1740
|
+
export declare type RadiologyInsightsInferenceTypeOutput = string | "ageMismatch" | "lateralityDiscrepancy" | "sexMismatch" | "completeOrderDiscrepancy" | "limitedOrderDiscrepancy" | "finding" | "criticalResult" | "followupRecommendation" | "followupCommunication" | "radiologyProcedure";
|
|
1741
|
+
|
|
1742
|
+
/** Response for the Radiology Insights request. */
|
|
1743
|
+
export declare interface RadiologyInsightsJob {
|
|
1744
|
+
/** The request data for the operation. */
|
|
1745
|
+
jobData?: RadiologyInsightsData;
|
|
1746
|
+
}
|
|
1747
|
+
|
|
1748
|
+
/** Response for the Radiology Insights request. */
|
|
1749
|
+
export declare interface RadiologyInsightsJobOutput {
|
|
1750
|
+
/** The request data for the operation. */
|
|
1751
|
+
jobData?: RadiologyInsightsDataOutput;
|
|
1752
|
+
/** The result of the operation. */
|
|
1753
|
+
readonly result?: RadiologyInsightsInferenceResultOutput;
|
|
1754
|
+
/** The unique ID of the job. */
|
|
1755
|
+
readonly id: string;
|
|
1756
|
+
/** The status of the job. */
|
|
1757
|
+
readonly status: JobStatusOutput;
|
|
1758
|
+
/** The date and time when the processing job was created. */
|
|
1759
|
+
readonly createdAt?: string;
|
|
1760
|
+
/** The date and time when the processing job is set to expire. */
|
|
1761
|
+
readonly expiresAt?: string;
|
|
1762
|
+
/** The date and time when the processing job was last updated. */
|
|
1763
|
+
readonly updatedAt?: string;
|
|
1764
|
+
/** Error object that describes the error when status is "Failed". */
|
|
1765
|
+
readonly error?: ErrorModel;
|
|
1766
|
+
}
|
|
1767
|
+
|
|
1768
|
+
/** Configuration affecting the Radiology Insights model's inference. */
|
|
1769
|
+
export declare interface RadiologyInsightsModelConfiguration {
|
|
1770
|
+
/** An indication whether the model should produce verbose output. */
|
|
1771
|
+
verbose?: boolean;
|
|
1772
|
+
/** An indication whether the model's output should include evidence for the inferences. */
|
|
1773
|
+
includeEvidence?: boolean;
|
|
1774
|
+
/** This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types. */
|
|
1775
|
+
inferenceTypes?: RadiologyInsightsInferenceType[];
|
|
1776
|
+
/** Options regarding follow up recommendation inferences and finding inferences. */
|
|
1777
|
+
inferenceOptions?: RadiologyInsightsInferenceOptions;
|
|
1778
|
+
/** Local for the model to use. If not specified, the model will use the default locale. */
|
|
1779
|
+
locale?: string;
|
|
1780
|
+
}
|
|
1781
|
+
|
|
1782
|
+
/** Configuration affecting the Radiology Insights model's inference. */
|
|
1783
|
+
export declare interface RadiologyInsightsModelConfigurationOutput {
|
|
1784
|
+
/** An indication whether the model should produce verbose output. */
|
|
1785
|
+
verbose?: boolean;
|
|
1786
|
+
/** An indication whether the model's output should include evidence for the inferences. */
|
|
1787
|
+
includeEvidence?: boolean;
|
|
1788
|
+
/** This is a list of inference types to be inferred for the current request. It could be used if only part of the Radiology Insights inferences are required. If this list is omitted or empty, the model will return all the inference types. */
|
|
1789
|
+
inferenceTypes?: RadiologyInsightsInferenceTypeOutput[];
|
|
1790
|
+
/** Options regarding follow up recommendation inferences and finding inferences. */
|
|
1791
|
+
inferenceOptions?: RadiologyInsightsInferenceOptionsOutput;
|
|
1792
|
+
/** Local for the model to use. If not specified, the model will use the default locale. */
|
|
1793
|
+
locale?: string;
|
|
1794
|
+
}
|
|
1795
|
+
|
|
1796
|
+
/** Results of the model's work for a single patient. */
|
|
1797
|
+
export declare interface RadiologyInsightsPatientResult {
|
|
1798
|
+
/** Identifier given for the patient in the request. */
|
|
1799
|
+
patientId: string;
|
|
1800
|
+
/** The model's inferences for the given patient. */
|
|
1801
|
+
inferences: Array<RadiologyInsightsInference>;
|
|
1802
|
+
}
|
|
1803
|
+
|
|
1804
|
+
/** Results of the model's work for a single patient. */
|
|
1805
|
+
export declare interface RadiologyInsightsPatientResultOutput {
|
|
1806
|
+
/** Identifier given for the patient in the request. */
|
|
1807
|
+
patientId: string;
|
|
1808
|
+
/** The model's inferences for the given patient. */
|
|
1809
|
+
inferences: Array<RadiologyInsightsInferenceOutput>;
|
|
1810
|
+
}
|
|
1811
|
+
|
|
1812
|
+
/** Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text. */
|
|
1813
|
+
export declare interface RadiologyProcedureInference extends RadiologyInsightsInferenceParent {
|
|
1814
|
+
/** Inference type. */
|
|
1815
|
+
kind: "radiologyProcedure";
|
|
1816
|
+
/** LOINC codes for the procedure. */
|
|
1817
|
+
procedureCodes?: Array<CodeableConcept>;
|
|
1818
|
+
/** Imaging procedures. */
|
|
1819
|
+
imagingProcedures: Array<ImagingProcedure>;
|
|
1820
|
+
/** Ordered procedure information from the document information or text. */
|
|
1821
|
+
orderedProcedure: OrderedProcedure;
|
|
1822
|
+
}
|
|
1823
|
+
|
|
1824
|
+
/** Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text. */
|
|
1825
|
+
export declare interface RadiologyProcedureInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
1826
|
+
/** Inference type. */
|
|
1827
|
+
kind: "radiologyProcedure";
|
|
1828
|
+
/** LOINC codes for the procedure. */
|
|
1829
|
+
procedureCodes?: Array<CodeableConceptOutput>;
|
|
1830
|
+
/** Imaging procedures. */
|
|
1831
|
+
imagingProcedures: Array<ImagingProcedureOutput>;
|
|
1832
|
+
/** Ordered procedure information from the document information or text. */
|
|
1833
|
+
orderedProcedure: OrderedProcedureOutput;
|
|
1834
|
+
}
|
|
1835
|
+
|
|
1836
|
+
/**
|
|
1837
|
+
* A set of ordered Quantities defined by a low and high limit
|
|
1838
|
+
* Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range)
|
|
1839
|
+
*/
|
|
1840
|
+
export declare interface Range extends Element {
|
|
1841
|
+
/** Low limit */
|
|
1842
|
+
low?: Quantity;
|
|
1843
|
+
/** High limit */
|
|
1844
|
+
high?: Quantity;
|
|
1845
|
+
}
|
|
1846
|
+
|
|
1847
|
+
/**
|
|
1848
|
+
* A set of ordered Quantities defined by a low and high limit
|
|
1849
|
+
* Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range)
|
|
1850
|
+
*/
|
|
1851
|
+
export declare interface RangeOutput extends ElementOutput {
|
|
1852
|
+
/** Low limit */
|
|
1853
|
+
low?: QuantityOutput;
|
|
1854
|
+
/** High limit */
|
|
1855
|
+
high?: QuantityOutput;
|
|
1856
|
+
}
|
|
1857
|
+
|
|
1858
|
+
/**
|
|
1859
|
+
* A ratio of two Quantity values - a numerator and a denominator
|
|
1860
|
+
* Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio)
|
|
1861
|
+
*/
|
|
1862
|
+
export declare interface Ratio extends Element {
|
|
1863
|
+
/** Numerator value */
|
|
1864
|
+
numerator?: Quantity;
|
|
1865
|
+
/** Denominator value */
|
|
1866
|
+
denominator?: Quantity;
|
|
1867
|
+
}
|
|
1868
|
+
|
|
1869
|
+
/**
|
|
1870
|
+
* A ratio of two Quantity values - a numerator and a denominator
|
|
1871
|
+
* Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio)
|
|
1872
|
+
*/
|
|
1873
|
+
export declare interface RatioOutput extends ElementOutput {
|
|
1874
|
+
/** Numerator value */
|
|
1875
|
+
numerator?: QuantityOutput;
|
|
1876
|
+
/** Denominator value */
|
|
1877
|
+
denominator?: QuantityOutput;
|
|
1878
|
+
}
|
|
1879
|
+
|
|
1880
|
+
/** Finding reference for recommendation. */
|
|
1881
|
+
export declare interface RecommendationFinding {
|
|
1882
|
+
/** Finding linked to a recommendation. */
|
|
1883
|
+
finding?: Observation;
|
|
1884
|
+
/** Critical result linked to a recommendation. */
|
|
1885
|
+
criticalFinding?: CriticalResult;
|
|
1886
|
+
/** Recommendation finding status. */
|
|
1887
|
+
recommendationFindingStatus: RecommendationFindingStatusType;
|
|
1888
|
+
/** Additional Content defined by implementations */
|
|
1889
|
+
extension?: Array<Extension>;
|
|
1890
|
+
}
|
|
1891
|
+
|
|
1892
|
+
/** Finding reference for recommendation. */
|
|
1893
|
+
export declare interface RecommendationFindingOutput {
|
|
1894
|
+
/** Finding linked to a recommendation. */
|
|
1895
|
+
finding?: ObservationOutput;
|
|
1896
|
+
/** Critical result linked to a recommendation. */
|
|
1897
|
+
criticalFinding?: CriticalResultOutput;
|
|
1898
|
+
/** Recommendation finding status. */
|
|
1899
|
+
recommendationFindingStatus: RecommendationFindingStatusTypeOutput;
|
|
1900
|
+
/** Additional Content defined by implementations */
|
|
1901
|
+
extension?: Array<ExtensionOutput>;
|
|
1902
|
+
}
|
|
1903
|
+
|
|
1904
|
+
/** Alias for RecommendationFindingStatusType */
|
|
1905
|
+
export declare type RecommendationFindingStatusType = string | "present" | "differential" | "ruleOut" | "conditional";
|
|
1906
|
+
|
|
1907
|
+
/** Alias for RecommendationFindingStatusTypeOutput */
|
|
1908
|
+
export declare type RecommendationFindingStatusTypeOutput = string | "present" | "differential" | "ruleOut" | "conditional";
|
|
1909
|
+
|
|
1910
|
+
/**
|
|
1911
|
+
* A reference from one resource to another
|
|
1912
|
+
* Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)
|
|
1913
|
+
*/
|
|
1914
|
+
export declare interface Reference extends Element {
|
|
1915
|
+
/** Literal reference, Relative, internal or absolute URL */
|
|
1916
|
+
reference?: string;
|
|
1917
|
+
/** Type the reference refers to (e.g. "Patient") */
|
|
1918
|
+
type?: string;
|
|
1919
|
+
/** Logical reference, when literal reference is not known */
|
|
1920
|
+
identifier?: Identifier;
|
|
1921
|
+
/** Text alternative for the resource */
|
|
1922
|
+
display?: string;
|
|
1923
|
+
}
|
|
1924
|
+
|
|
1925
|
+
/**
|
|
1926
|
+
* A reference from one resource to another
|
|
1927
|
+
* Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)
|
|
1928
|
+
*/
|
|
1929
|
+
export declare interface ReferenceOutput extends ElementOutput {
|
|
1930
|
+
/** Literal reference, Relative, internal or absolute URL */
|
|
1931
|
+
reference?: string;
|
|
1932
|
+
/** Type the reference refers to (e.g. "Patient") */
|
|
1933
|
+
type?: string;
|
|
1934
|
+
/** Logical reference, when literal reference is not known */
|
|
1935
|
+
identifier?: IdentifierOutput;
|
|
1936
|
+
/** Text alternative for the resource */
|
|
1937
|
+
display?: string;
|
|
1938
|
+
}
|
|
1939
|
+
|
|
1940
|
+
/** Provides the 'x-ms-request-id' header to enable request correlation in responses. */
|
|
1941
|
+
export declare interface RequestIdResponseHeaderOutput {
|
|
1942
|
+
}
|
|
1943
|
+
|
|
1944
|
+
/**
|
|
1945
|
+
* Detailed information about Research Study
|
|
1946
|
+
* Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)
|
|
1947
|
+
*/
|
|
1948
|
+
export declare interface ResearchStudy extends DomainResourceParent {
|
|
1949
|
+
/** resourceType */
|
|
1950
|
+
resourceType: "ResearchStudy";
|
|
1951
|
+
/** Business Identifier for study */
|
|
1952
|
+
identifier?: Array<Identifier>;
|
|
1953
|
+
/** Name for this study */
|
|
1954
|
+
title?: string;
|
|
1955
|
+
/** Steps followed in executing study */
|
|
1956
|
+
protocol?: Array<Reference>;
|
|
1957
|
+
/** Part of larger study */
|
|
1958
|
+
partOf?: Array<Reference>;
|
|
1959
|
+
/** active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn */
|
|
1960
|
+
status: ResearchStudyStatusCodeType;
|
|
1961
|
+
/** treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility */
|
|
1962
|
+
primaryPurposeType?: CodeableConcept;
|
|
1963
|
+
/** n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 */
|
|
1964
|
+
phase?: CodeableConcept;
|
|
1965
|
+
/** Classifications for the study */
|
|
1966
|
+
category?: Array<CodeableConcept>;
|
|
1967
|
+
/** Drugs, devices, etc. under study */
|
|
1968
|
+
focus?: Array<CodeableConcept>;
|
|
1969
|
+
/** Condition being studied */
|
|
1970
|
+
condition?: Array<CodeableConcept>;
|
|
1971
|
+
/** Contact details for the study */
|
|
1972
|
+
contact?: Array<ContactDetail>;
|
|
1973
|
+
/** Used to search for the study */
|
|
1974
|
+
keyword?: Array<CodeableConcept>;
|
|
1975
|
+
/** Geographic region(s) for study */
|
|
1976
|
+
location?: Array<CodeableConcept>;
|
|
1977
|
+
/** What this is study doing */
|
|
1978
|
+
description?: string;
|
|
1979
|
+
/** Inclusion & exclusion criteria */
|
|
1980
|
+
enrollment?: Array<Reference>;
|
|
1981
|
+
/** When the study began and ended */
|
|
1982
|
+
period?: Period;
|
|
1983
|
+
/** Organization that initiates and is legally responsible for the study */
|
|
1984
|
+
sponsor?: Reference;
|
|
1985
|
+
/** Researcher who oversees multiple aspects of the study */
|
|
1986
|
+
principalInvestigator?: Reference;
|
|
1987
|
+
/** Facility where study activities are conducted */
|
|
1988
|
+
site?: Array<Reference>;
|
|
1989
|
+
/** accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design */
|
|
1990
|
+
reasonStopped?: CodeableConcept;
|
|
1991
|
+
/** Comments made about the study */
|
|
1992
|
+
note?: Array<Annotation>;
|
|
1993
|
+
/** Defined path through the study for a subject */
|
|
1994
|
+
arm?: {
|
|
1995
|
+
name: string;
|
|
1996
|
+
type?: CodeableConcept;
|
|
1997
|
+
description?: string;
|
|
1998
|
+
}[];
|
|
1999
|
+
/** A goal for the study */
|
|
2000
|
+
objective?: {
|
|
2001
|
+
name: string;
|
|
2002
|
+
type?: CodeableConcept;
|
|
2003
|
+
}[];
|
|
2004
|
+
}
|
|
2005
|
+
|
|
2006
|
+
/**
|
|
2007
|
+
* Detailed information about Research Study
|
|
2008
|
+
* Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)
|
|
2009
|
+
*/
|
|
2010
|
+
export declare interface ResearchStudyOutput extends DomainResourceOutputParent {
|
|
2011
|
+
/** resourceType */
|
|
2012
|
+
resourceType: "ResearchStudy";
|
|
2013
|
+
/** Business Identifier for study */
|
|
2014
|
+
identifier?: Array<IdentifierOutput>;
|
|
2015
|
+
/** Name for this study */
|
|
2016
|
+
title?: string;
|
|
2017
|
+
/** Steps followed in executing study */
|
|
2018
|
+
protocol?: Array<ReferenceOutput>;
|
|
2019
|
+
/** Part of larger study */
|
|
2020
|
+
partOf?: Array<ReferenceOutput>;
|
|
2021
|
+
/** active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn */
|
|
2022
|
+
status: ResearchStudyStatusCodeTypeOutput;
|
|
2023
|
+
/** treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility */
|
|
2024
|
+
primaryPurposeType?: CodeableConceptOutput;
|
|
2025
|
+
/** n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 */
|
|
2026
|
+
phase?: CodeableConceptOutput;
|
|
2027
|
+
/** Classifications for the study */
|
|
2028
|
+
category?: Array<CodeableConceptOutput>;
|
|
2029
|
+
/** Drugs, devices, etc. under study */
|
|
2030
|
+
focus?: Array<CodeableConceptOutput>;
|
|
2031
|
+
/** Condition being studied */
|
|
2032
|
+
condition?: Array<CodeableConceptOutput>;
|
|
2033
|
+
/** Contact details for the study */
|
|
2034
|
+
contact?: Array<ContactDetailOutput>;
|
|
2035
|
+
/** Used to search for the study */
|
|
2036
|
+
keyword?: Array<CodeableConceptOutput>;
|
|
2037
|
+
/** Geographic region(s) for study */
|
|
2038
|
+
location?: Array<CodeableConceptOutput>;
|
|
2039
|
+
/** What this is study doing */
|
|
2040
|
+
description?: string;
|
|
2041
|
+
/** Inclusion & exclusion criteria */
|
|
2042
|
+
enrollment?: Array<ReferenceOutput>;
|
|
2043
|
+
/** When the study began and ended */
|
|
2044
|
+
period?: PeriodOutput;
|
|
2045
|
+
/** Organization that initiates and is legally responsible for the study */
|
|
2046
|
+
sponsor?: ReferenceOutput;
|
|
2047
|
+
/** Researcher who oversees multiple aspects of the study */
|
|
2048
|
+
principalInvestigator?: ReferenceOutput;
|
|
2049
|
+
/** Facility where study activities are conducted */
|
|
2050
|
+
site?: Array<ReferenceOutput>;
|
|
2051
|
+
/** accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design */
|
|
2052
|
+
reasonStopped?: CodeableConceptOutput;
|
|
2053
|
+
/** Comments made about the study */
|
|
2054
|
+
note?: Array<AnnotationOutput>;
|
|
2055
|
+
/** Defined path through the study for a subject */
|
|
2056
|
+
arm?: {
|
|
2057
|
+
name: string;
|
|
2058
|
+
type?: CodeableConceptOutput;
|
|
2059
|
+
description?: string;
|
|
2060
|
+
}[];
|
|
2061
|
+
/** A goal for the study */
|
|
2062
|
+
objective?: {
|
|
2063
|
+
name: string;
|
|
2064
|
+
type?: CodeableConceptOutput;
|
|
2065
|
+
}[];
|
|
2066
|
+
}
|
|
2067
|
+
|
|
2068
|
+
/** Alias for ResearchStudyStatusCodeType */
|
|
2069
|
+
export declare type ResearchStudyStatusCodeType = string | "active" | "administratively-completed" | "approved" | "closed-to-accrual" | "closed-to-accrual-and-intervention" | "completed" | "disapproved" | "in-review" | "temporarily-closed-to-accrual" | "temporarily-closed-to-accrual-and-intervention" | "withdrawn";
|
|
2070
|
+
|
|
2071
|
+
/** Alias for ResearchStudyStatusCodeTypeOutput */
|
|
2072
|
+
export declare type ResearchStudyStatusCodeTypeOutput = string | "active" | "administratively-completed" | "approved" | "closed-to-accrual" | "closed-to-accrual-and-intervention" | "completed" | "disapproved" | "in-review" | "temporarily-closed-to-accrual" | "temporarily-closed-to-accrual-and-intervention" | "withdrawn";
|
|
2073
|
+
|
|
2074
|
+
/**
|
|
2075
|
+
* Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly.
|
|
2076
|
+
* Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html
|
|
2077
|
+
*/
|
|
2078
|
+
export declare interface Resource extends Record<string, unknown> {
|
|
2079
|
+
/** resourceType */
|
|
2080
|
+
resourceType: string;
|
|
2081
|
+
/** Resource Id */
|
|
2082
|
+
id?: string;
|
|
2083
|
+
/** Metadata about the resource */
|
|
2084
|
+
meta?: Meta;
|
|
2085
|
+
/** A set of rules under which this content was created */
|
|
2086
|
+
implicitRules?: string;
|
|
2087
|
+
/** Language of the resource content */
|
|
2088
|
+
language?: string;
|
|
2089
|
+
}
|
|
2090
|
+
|
|
2091
|
+
/**
|
|
2092
|
+
* Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly.
|
|
2093
|
+
* Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html
|
|
2094
|
+
*/
|
|
2095
|
+
export declare interface ResourceOutput extends Record<string, any> {
|
|
2096
|
+
/** The type of resource */
|
|
2097
|
+
resourceType: string;
|
|
2098
|
+
/** Resource Id */
|
|
2099
|
+
id?: string;
|
|
2100
|
+
/** Metadata about the resource */
|
|
2101
|
+
meta?: MetaOutput;
|
|
2102
|
+
/** A set of rules under which this content was created */
|
|
2103
|
+
implicitRules?: string;
|
|
2104
|
+
/** Language of the resource content */
|
|
2105
|
+
language?: string;
|
|
2106
|
+
}
|
|
2107
|
+
|
|
2108
|
+
/** The routes for the resource */
|
|
2109
|
+
export declare interface Routes {
|
|
2110
|
+
/** Resource for '/radiology-insights/jobs/\{id\}' has methods for the following verbs: get, put */
|
|
2111
|
+
(path: "/radiology-insights/jobs/{id}", id: string): GetJob;
|
|
2112
|
+
}
|
|
2113
|
+
|
|
2114
|
+
/**
|
|
2115
|
+
* A series of measurements taken by a device
|
|
2116
|
+
* Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData)
|
|
2117
|
+
*/
|
|
2118
|
+
export declare interface SampledData extends Element {
|
|
2119
|
+
/** Zero value and units */
|
|
2120
|
+
origin: Quantity;
|
|
2121
|
+
/** Number of milliseconds between samples */
|
|
2122
|
+
period: number;
|
|
2123
|
+
/** Multiply data by this before adding to origin */
|
|
2124
|
+
factor?: number;
|
|
2125
|
+
/** Lower limit of detection */
|
|
2126
|
+
lowerLimit?: number;
|
|
2127
|
+
/** Upper limit of detection */
|
|
2128
|
+
upperLimit?: number;
|
|
2129
|
+
/** Number of sample points at each time point */
|
|
2130
|
+
dimensions: number;
|
|
2131
|
+
/** Decimal values with spaces, or "E" | "U" | "L" */
|
|
2132
|
+
data?: string;
|
|
2133
|
+
}
|
|
2134
|
+
|
|
2135
|
+
/**
|
|
2136
|
+
* A series of measurements taken by a device
|
|
2137
|
+
* Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData)
|
|
2138
|
+
*/
|
|
2139
|
+
export declare interface SampledDataOutput extends ElementOutput {
|
|
2140
|
+
/** Zero value and units */
|
|
2141
|
+
origin: QuantityOutput;
|
|
2142
|
+
/** Number of milliseconds between samples */
|
|
2143
|
+
period: number;
|
|
2144
|
+
/** Multiply data by this before adding to origin */
|
|
2145
|
+
factor?: number;
|
|
2146
|
+
/** Lower limit of detection */
|
|
2147
|
+
lowerLimit?: number;
|
|
2148
|
+
/** Upper limit of detection */
|
|
2149
|
+
upperLimit?: number;
|
|
2150
|
+
/** Number of sample points at each time point */
|
|
2151
|
+
dimensions: number;
|
|
2152
|
+
/** Decimal values with spaces, or "E" | "U" | "L" */
|
|
2153
|
+
data?: string;
|
|
2154
|
+
}
|
|
2155
|
+
|
|
2156
|
+
/** A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information. */
|
|
2157
|
+
export declare interface SexMismatchInference extends RadiologyInsightsInferenceParent {
|
|
2158
|
+
/** Inference type. */
|
|
2159
|
+
kind: "sexMismatch";
|
|
2160
|
+
/** Sex indication : SNOMED CT code for gender finding. */
|
|
2161
|
+
sexIndication: CodeableConcept;
|
|
2162
|
+
}
|
|
2163
|
+
|
|
2164
|
+
/** A notification for a sex mismatch is displayed when the gender, personal pronouns, gender-related body parts, or gender-related procedures mentioned in a patient's clinical document are either inconsistent or do not match the gender specified in the patient information. */
|
|
2165
|
+
export declare interface SexMismatchInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
2166
|
+
/** Inference type. */
|
|
2167
|
+
kind: "sexMismatch";
|
|
2168
|
+
/** Sex indication : SNOMED CT code for gender finding. */
|
|
2169
|
+
sexIndication: CodeableConceptOutput;
|
|
2170
|
+
}
|
|
2171
|
+
|
|
2172
|
+
/** Alias for SpecialtyType */
|
|
2173
|
+
export declare type SpecialtyType = string | "pathology" | "radiology";
|
|
2174
|
+
|
|
2175
|
+
/** Alias for SpecialtyTypeOutput */
|
|
2176
|
+
export declare type SpecialtyTypeOutput = string | "pathology" | "radiology";
|
|
2177
|
+
|
|
2178
|
+
/** A duration of time during which an event is happening */
|
|
2179
|
+
export declare interface TimePeriod {
|
|
2180
|
+
/** Starting time with inclusive boundary */
|
|
2181
|
+
start?: Date | string;
|
|
2182
|
+
/** End time with inclusive boundary, if not ongoing */
|
|
2183
|
+
end?: Date | string;
|
|
2184
|
+
}
|
|
2185
|
+
|
|
2186
|
+
/** A duration of time during which an event is happening */
|
|
2187
|
+
export declare interface TimePeriodOutput {
|
|
2188
|
+
/** Starting time with inclusive boundary */
|
|
2189
|
+
start?: string;
|
|
2190
|
+
/** End time with inclusive boundary, if not ongoing */
|
|
2191
|
+
end?: string;
|
|
2192
|
+
}
|
|
2193
|
+
|
|
2194
|
+
export { }
|