@azure-rest/health-insights-radiologyinsights 1.0.0-beta.1 → 2.0.0-alpha.20250604.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/CHANGELOG.md +111 -0
- package/LICENSE +21 -0
- package/README.md +902 -181
- package/dist/browser/azureHealthInsightsClient.d.ts +16 -0
- package/dist/browser/azureHealthInsightsClient.d.ts.map +1 -0
- package/dist/browser/azureHealthInsightsClient.js +46 -0
- package/dist/browser/azureHealthInsightsClient.js.map +1 -0
- package/dist/browser/clientDefinitions.d.ts +21 -0
- package/dist/browser/clientDefinitions.d.ts.map +1 -0
- package/dist/browser/clientDefinitions.js +4 -0
- package/dist/browser/clientDefinitions.js.map +1 -0
- package/dist/browser/index.d.ts +11 -0
- package/dist/browser/index.d.ts.map +1 -0
- package/dist/browser/index.js +14 -0
- package/dist/browser/index.js.map +1 -0
- package/dist/browser/isUnexpected.d.ts +6 -0
- package/dist/browser/isUnexpected.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/isUnexpected.js +3 -3
- package/dist/browser/isUnexpected.js.map +1 -0
- package/dist/browser/logger.d.ts +2 -0
- package/dist/browser/logger.d.ts.map +1 -0
- package/{dist-esm/src → dist/browser}/logger.js +1 -1
- package/{dist-esm/src → dist/browser}/logger.js.map +1 -1
- package/dist/browser/models.d.ts +1031 -0
- package/dist/browser/models.d.ts.map +1 -0
- package/dist/browser/models.js +4 -0
- package/dist/browser/models.js.map +1 -0
- package/dist/browser/outputModels.d.ts +1061 -0
- package/dist/browser/outputModels.d.ts.map +1 -0
- package/dist/browser/outputModels.js +4 -0
- package/dist/browser/outputModels.js.map +1 -0
- package/dist/browser/package.json +3 -0
- package/dist/browser/parameters.d.ts +50 -0
- package/dist/browser/parameters.d.ts.map +1 -0
- package/dist/browser/parameters.js +4 -0
- package/dist/browser/parameters.js.map +1 -0
- package/dist/browser/pollingHelper.d.ts +77 -0
- package/dist/browser/pollingHelper.d.ts.map +1 -0
- package/dist/browser/pollingHelper.js +97 -0
- package/dist/browser/pollingHelper.js.map +1 -0
- package/dist/browser/responses.d.ts +91 -0
- package/dist/browser/responses.d.ts.map +1 -0
- package/dist/browser/responses.js +4 -0
- package/dist/browser/responses.js.map +1 -0
- package/dist/commonjs/azureHealthInsightsClient.d.ts +16 -0
- package/dist/commonjs/azureHealthInsightsClient.d.ts.map +1 -0
- package/dist/commonjs/azureHealthInsightsClient.js +49 -0
- package/dist/commonjs/azureHealthInsightsClient.js.map +1 -0
- package/dist/commonjs/clientDefinitions.d.ts +21 -0
- package/dist/commonjs/clientDefinitions.d.ts.map +1 -0
- package/dist/commonjs/clientDefinitions.js +5 -0
- package/dist/commonjs/clientDefinitions.js.map +1 -0
- package/dist/commonjs/index.d.ts +11 -0
- package/dist/commonjs/index.d.ts.map +1 -0
- package/dist/commonjs/index.js +17 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/isUnexpected.d.ts +6 -0
- package/dist/commonjs/isUnexpected.d.ts.map +1 -0
- package/dist/commonjs/isUnexpected.js +75 -0
- package/dist/commonjs/isUnexpected.js.map +1 -0
- package/dist/commonjs/logger.d.ts +2 -0
- package/dist/commonjs/logger.d.ts.map +1 -0
- package/dist/commonjs/logger.js +8 -0
- package/dist/commonjs/logger.js.map +1 -0
- package/dist/commonjs/models.d.ts +1031 -0
- package/dist/commonjs/models.d.ts.map +1 -0
- package/dist/commonjs/models.js +5 -0
- package/dist/commonjs/models.js.map +1 -0
- package/dist/commonjs/outputModels.d.ts +1061 -0
- package/dist/commonjs/outputModels.d.ts.map +1 -0
- package/dist/commonjs/outputModels.js +5 -0
- package/dist/commonjs/outputModels.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/parameters.d.ts +50 -0
- package/dist/commonjs/parameters.d.ts.map +1 -0
- package/dist/commonjs/parameters.js +5 -0
- package/dist/commonjs/parameters.js.map +1 -0
- package/dist/commonjs/pollingHelper.d.ts +77 -0
- package/dist/commonjs/pollingHelper.d.ts.map +1 -0
- package/dist/commonjs/pollingHelper.js +100 -0
- package/dist/commonjs/pollingHelper.js.map +1 -0
- package/dist/commonjs/responses.d.ts +91 -0
- package/dist/commonjs/responses.d.ts.map +1 -0
- package/dist/commonjs/responses.js +5 -0
- package/dist/commonjs/responses.js.map +1 -0
- package/dist/commonjs/tsdoc-metadata.json +11 -0
- package/dist/esm/azureHealthInsightsClient.d.ts +16 -0
- package/dist/esm/azureHealthInsightsClient.d.ts.map +1 -0
- package/dist/esm/azureHealthInsightsClient.js +46 -0
- package/dist/esm/azureHealthInsightsClient.js.map +1 -0
- package/dist/esm/clientDefinitions.d.ts +21 -0
- package/dist/esm/clientDefinitions.d.ts.map +1 -0
- package/dist/esm/clientDefinitions.js +4 -0
- package/dist/esm/clientDefinitions.js.map +1 -0
- package/dist/esm/index.d.ts +11 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +14 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/isUnexpected.d.ts +6 -0
- package/dist/esm/isUnexpected.d.ts.map +1 -0
- package/dist/esm/isUnexpected.js +72 -0
- package/dist/esm/isUnexpected.js.map +1 -0
- package/dist/esm/logger.d.ts +2 -0
- package/dist/esm/logger.d.ts.map +1 -0
- package/dist/esm/logger.js +5 -0
- package/dist/esm/logger.js.map +1 -0
- package/dist/esm/models.d.ts +1031 -0
- package/dist/esm/models.d.ts.map +1 -0
- package/dist/esm/models.js +4 -0
- package/dist/esm/models.js.map +1 -0
- package/dist/esm/outputModels.d.ts +1061 -0
- package/dist/esm/outputModels.d.ts.map +1 -0
- package/dist/esm/outputModels.js +4 -0
- package/dist/esm/outputModels.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/parameters.d.ts +50 -0
- package/dist/esm/parameters.d.ts.map +1 -0
- package/dist/esm/parameters.js +4 -0
- package/dist/esm/parameters.js.map +1 -0
- package/dist/esm/pollingHelper.d.ts +77 -0
- package/dist/esm/pollingHelper.d.ts.map +1 -0
- package/dist/esm/pollingHelper.js +97 -0
- package/dist/esm/pollingHelper.js.map +1 -0
- package/dist/esm/responses.d.ts +91 -0
- package/dist/esm/responses.d.ts.map +1 -0
- package/dist/esm/responses.js +4 -0
- package/dist/esm/responses.js.map +1 -0
- package/dist/react-native/azureHealthInsightsClient.d.ts +16 -0
- package/dist/react-native/azureHealthInsightsClient.d.ts.map +1 -0
- package/dist/react-native/azureHealthInsightsClient.js +46 -0
- package/dist/react-native/azureHealthInsightsClient.js.map +1 -0
- package/dist/react-native/clientDefinitions.d.ts +21 -0
- package/dist/react-native/clientDefinitions.d.ts.map +1 -0
- package/dist/react-native/clientDefinitions.js +4 -0
- package/dist/react-native/clientDefinitions.js.map +1 -0
- package/dist/react-native/index.d.ts +11 -0
- package/dist/react-native/index.d.ts.map +1 -0
- package/dist/react-native/index.js +14 -0
- package/dist/react-native/index.js.map +1 -0
- package/dist/react-native/isUnexpected.d.ts +6 -0
- package/dist/react-native/isUnexpected.d.ts.map +1 -0
- package/dist/react-native/isUnexpected.js +72 -0
- package/dist/react-native/isUnexpected.js.map +1 -0
- package/dist/react-native/logger.d.ts +2 -0
- package/dist/react-native/logger.d.ts.map +1 -0
- package/dist/react-native/logger.js +5 -0
- package/dist/react-native/logger.js.map +1 -0
- package/dist/react-native/models.d.ts +1031 -0
- package/dist/react-native/models.d.ts.map +1 -0
- package/dist/react-native/models.js +4 -0
- package/dist/react-native/models.js.map +1 -0
- package/dist/react-native/outputModels.d.ts +1061 -0
- package/dist/react-native/outputModels.d.ts.map +1 -0
- package/dist/react-native/outputModels.js +4 -0
- package/dist/react-native/outputModels.js.map +1 -0
- package/dist/react-native/package.json +3 -0
- package/dist/react-native/parameters.d.ts +50 -0
- package/dist/react-native/parameters.d.ts.map +1 -0
- package/dist/react-native/parameters.js +4 -0
- package/dist/react-native/parameters.js.map +1 -0
- package/dist/react-native/pollingHelper.d.ts +77 -0
- package/dist/react-native/pollingHelper.d.ts.map +1 -0
- package/dist/react-native/pollingHelper.js +97 -0
- package/dist/react-native/pollingHelper.js.map +1 -0
- package/dist/react-native/responses.d.ts +91 -0
- package/dist/react-native/responses.d.ts.map +1 -0
- package/dist/react-native/responses.js +4 -0
- package/dist/react-native/responses.js.map +1 -0
- package/package.json +79 -68
- package/review/health-insights-radiologyinsights.api.md +581 -168
- package/dist/index.js +0 -159
- package/dist/index.js.map +0 -1
- package/dist-esm/src/azureHealthInsightsClient.js +0 -28
- package/dist-esm/src/azureHealthInsightsClient.js.map +0 -1
- package/dist-esm/src/clientDefinitions.js +0 -4
- package/dist-esm/src/clientDefinitions.js.map +0 -1
- package/dist-esm/src/index.js +0 -13
- package/dist-esm/src/index.js.map +0 -1
- package/dist-esm/src/isUnexpected.js.map +0 -1
- package/dist-esm/src/models.js +0 -4
- package/dist-esm/src/models.js.map +0 -1
- package/dist-esm/src/outputModels.js +0 -4
- package/dist-esm/src/outputModels.js.map +0 -1
- package/dist-esm/src/parameters.js +0 -4
- package/dist-esm/src/parameters.js.map +0 -1
- package/dist-esm/src/pollingHelper.js +0 -43
- package/dist-esm/src/pollingHelper.js.map +0 -1
- package/dist-esm/src/responses.js +0 -4
- package/dist-esm/src/responses.js.map +0 -1
|
@@ -0,0 +1,1061 @@
|
|
|
1
|
+
import type { ErrorModel } from "@azure-rest/core-client";
|
|
2
|
+
/** Response for the Radiology Insights request. */
|
|
3
|
+
export interface RadiologyInsightsJobOutput {
|
|
4
|
+
/** The request data for the operation. */
|
|
5
|
+
jobData?: RadiologyInsightsDataOutput;
|
|
6
|
+
/** The result of the operation. */
|
|
7
|
+
readonly result?: RadiologyInsightsInferenceResultOutput;
|
|
8
|
+
/** The unique ID of the job. */
|
|
9
|
+
readonly id: string;
|
|
10
|
+
/**
|
|
11
|
+
* The status of the job.
|
|
12
|
+
*
|
|
13
|
+
* Possible values: "notStarted", "running", "succeeded", "failed", "canceled"
|
|
14
|
+
*/
|
|
15
|
+
readonly status: JobStatusOutput;
|
|
16
|
+
/** The date and time when the processing job was created. */
|
|
17
|
+
readonly createdAt?: string;
|
|
18
|
+
/** The date and time when the processing job is set to expire. */
|
|
19
|
+
readonly expiresAt?: string;
|
|
20
|
+
/** The date and time when the processing job was last updated. */
|
|
21
|
+
readonly updatedAt?: string;
|
|
22
|
+
/** Error object that describes the error when status is "Failed". */
|
|
23
|
+
readonly error?: ErrorModel;
|
|
24
|
+
}
|
|
25
|
+
/** Contains the list of patients, and configuration data. */
|
|
26
|
+
export interface RadiologyInsightsDataOutput {
|
|
27
|
+
/** The list of patients, including their clinical information and data. */
|
|
28
|
+
patients: Array<PatientRecordOutput>;
|
|
29
|
+
/** Configuration affecting the Radiology Insights model's inference. */
|
|
30
|
+
configuration?: RadiologyInsightsModelConfigurationOutput;
|
|
31
|
+
}
|
|
32
|
+
/** A patient record, including their clinical information and data. */
|
|
33
|
+
export interface PatientRecordOutput {
|
|
34
|
+
/** A given identifier for the patient. Has to be unique across all patients in a single request. */
|
|
35
|
+
id: string;
|
|
36
|
+
/** Patient structured information, including demographics and known structured clinical information. */
|
|
37
|
+
details?: PatientDetailsOutput;
|
|
38
|
+
/** Patient encounters/visits. */
|
|
39
|
+
encounters?: Array<PatientEncounterOutput>;
|
|
40
|
+
/** Patient unstructured clinical data, given as documents. */
|
|
41
|
+
patientDocuments?: Array<PatientDocumentOutput>;
|
|
42
|
+
}
|
|
43
|
+
/** Patient structured information, including demographics and known structured clinical information. */
|
|
44
|
+
export interface PatientDetailsOutput {
|
|
45
|
+
/**
|
|
46
|
+
* The patient's sex.
|
|
47
|
+
*
|
|
48
|
+
* Possible values: "female", "male", "unspecified"
|
|
49
|
+
*/
|
|
50
|
+
sex?: PatientSexOutput;
|
|
51
|
+
/** The patient's date of birth. */
|
|
52
|
+
birthDate?: string;
|
|
53
|
+
/** Known clinical information for the patient, structured. */
|
|
54
|
+
clinicalInfo?: Array<ResourceOutput>;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Resource is the ancestor of DomainResource from which most resources are derived. Bundle, Parameters, and Binary extend Resource directly.
|
|
58
|
+
* Based on [FHIR Resource](https://www.hl7.org/fhir/r4/resource.html
|
|
59
|
+
*/
|
|
60
|
+
export interface ResourceOutput extends Record<string, any> {
|
|
61
|
+
/** The type of resource */
|
|
62
|
+
resourceType: string;
|
|
63
|
+
/** Resource Id */
|
|
64
|
+
id?: string;
|
|
65
|
+
/** Metadata about the resource */
|
|
66
|
+
meta?: MetaOutput;
|
|
67
|
+
/** A set of rules under which this content was created */
|
|
68
|
+
implicitRules?: string;
|
|
69
|
+
/** Language of the resource content */
|
|
70
|
+
language?: string;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Metadata about a resource
|
|
74
|
+
* Based on [FHIR Meta](https://www.hl7.org/fhir/R4/resource.html#Meta)
|
|
75
|
+
*/
|
|
76
|
+
export interface MetaOutput {
|
|
77
|
+
/** 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. */
|
|
78
|
+
versionId?: string;
|
|
79
|
+
/** When the resource last changed - e.g. when the version changed. */
|
|
80
|
+
lastUpdated?: string;
|
|
81
|
+
/** 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. */
|
|
82
|
+
source?: string;
|
|
83
|
+
/** 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). */
|
|
84
|
+
profile?: string[];
|
|
85
|
+
/** Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. */
|
|
86
|
+
security?: Array<CodingOutput>;
|
|
87
|
+
/** 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. */
|
|
88
|
+
tag?: Array<CodingOutput>;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* A Coding is a representation of a defined concept using a symbol from a defined "code system".
|
|
92
|
+
* Based on [FHIR Coding](https://www.hl7.org/fhir/R4/datatypes.html#Coding)
|
|
93
|
+
*/
|
|
94
|
+
export interface CodingOutput extends ElementOutput {
|
|
95
|
+
/** Identity of the terminology system */
|
|
96
|
+
system?: string;
|
|
97
|
+
/** Version of the system - if relevant */
|
|
98
|
+
version?: string;
|
|
99
|
+
/** Symbol in syntax defined by the system */
|
|
100
|
+
code?: string;
|
|
101
|
+
/** Representation defined by the system */
|
|
102
|
+
display?: string;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* The base definition for all elements contained inside a resource.
|
|
106
|
+
* Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)
|
|
107
|
+
*/
|
|
108
|
+
export interface ElementOutput {
|
|
109
|
+
/** Unique id for inter-element referencing */
|
|
110
|
+
id?: string;
|
|
111
|
+
/** Additional Content defined by implementations */
|
|
112
|
+
extension?: Array<ExtensionOutput>;
|
|
113
|
+
}
|
|
114
|
+
/**
|
|
115
|
+
* Base for all elements
|
|
116
|
+
* Based on [FHIR Element](https://www.hl7.org/fhir/R4/element.html)
|
|
117
|
+
*/
|
|
118
|
+
export interface ExtensionOutput extends ElementOutput {
|
|
119
|
+
/** Source of the definition for the extension code - a logical name or a URL. */
|
|
120
|
+
url: string;
|
|
121
|
+
/** Value as Quantity */
|
|
122
|
+
valueQuantity?: QuantityOutput;
|
|
123
|
+
/** Value as CodeableConcept */
|
|
124
|
+
valueCodeableConcept?: CodeableConceptOutput;
|
|
125
|
+
/** Value as string */
|
|
126
|
+
valueString?: string;
|
|
127
|
+
/** Value as boolean */
|
|
128
|
+
valueBoolean?: boolean;
|
|
129
|
+
/** Value as integer */
|
|
130
|
+
valueInteger?: number;
|
|
131
|
+
/** Value as Range. */
|
|
132
|
+
valueRange?: RangeOutput;
|
|
133
|
+
/** Value as Ratio. */
|
|
134
|
+
valueRatio?: RatioOutput;
|
|
135
|
+
/** Value as SampledData. */
|
|
136
|
+
valueSampledData?: SampledDataOutput;
|
|
137
|
+
/** Value as time (hh:mm:ss) */
|
|
138
|
+
valueTime?: string;
|
|
139
|
+
/** Value as dateTime. */
|
|
140
|
+
valueDateTime?: string;
|
|
141
|
+
/** Value as Period. */
|
|
142
|
+
valuePeriod?: PeriodOutput;
|
|
143
|
+
/** Value as reference. */
|
|
144
|
+
valueReference?: ReferenceOutput;
|
|
145
|
+
}
|
|
146
|
+
/**
|
|
147
|
+
* A measured or measurable amount
|
|
148
|
+
* Based on [FHIR Quantity](https://www.hl7.org/fhir/R4/datatypes.html#Quantity)
|
|
149
|
+
*/
|
|
150
|
+
export interface QuantityOutput extends ElementOutput {
|
|
151
|
+
/** Numerical value (with implicit precision) */
|
|
152
|
+
value?: number;
|
|
153
|
+
/** \< | \<= | \>= | \> - how to understand the value */
|
|
154
|
+
comparator?: string;
|
|
155
|
+
/** Unit representation */
|
|
156
|
+
unit?: string;
|
|
157
|
+
/** System that defines coded unit form */
|
|
158
|
+
system?: string;
|
|
159
|
+
/** Coded form of the unit */
|
|
160
|
+
code?: string;
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Concept - reference to a terminology or just text
|
|
164
|
+
* Based on [FHIR CodeableConcept](https://www.hl7.org/fhir/R4/datatypes.html#CodeableConcept)
|
|
165
|
+
*/
|
|
166
|
+
export interface CodeableConceptOutput extends ElementOutput {
|
|
167
|
+
/** Code defined by a terminology system */
|
|
168
|
+
coding?: Array<CodingOutput>;
|
|
169
|
+
/** Plain text representation of the concept */
|
|
170
|
+
text?: string;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* A set of ordered Quantities defined by a low and high limit
|
|
174
|
+
* Based on [FHIR Range](https://www.hl7.org/fhir/R4/datatypes.html#Range)
|
|
175
|
+
*/
|
|
176
|
+
export interface RangeOutput extends ElementOutput {
|
|
177
|
+
/** Low limit */
|
|
178
|
+
low?: QuantityOutput;
|
|
179
|
+
/** High limit */
|
|
180
|
+
high?: QuantityOutput;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* A ratio of two Quantity values - a numerator and a denominator
|
|
184
|
+
* Based on [FHIR Ratio](https://www.hl7.org/fhir/R4/datatypes.html#Ratio)
|
|
185
|
+
*/
|
|
186
|
+
export interface RatioOutput extends ElementOutput {
|
|
187
|
+
/** Numerator value */
|
|
188
|
+
numerator?: QuantityOutput;
|
|
189
|
+
/** Denominator value */
|
|
190
|
+
denominator?: QuantityOutput;
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* A series of measurements taken by a device
|
|
194
|
+
* Based on [FHIR SampledData](https://www.hl7.org/fhir/R4/datatypes.html#SampledData)
|
|
195
|
+
*/
|
|
196
|
+
export interface SampledDataOutput extends ElementOutput {
|
|
197
|
+
/** Zero value and units */
|
|
198
|
+
origin: QuantityOutput;
|
|
199
|
+
/** Number of milliseconds between samples */
|
|
200
|
+
period: number;
|
|
201
|
+
/** Multiply data by this before adding to origin */
|
|
202
|
+
factor?: number;
|
|
203
|
+
/** Lower limit of detection */
|
|
204
|
+
lowerLimit?: number;
|
|
205
|
+
/** Upper limit of detection */
|
|
206
|
+
upperLimit?: number;
|
|
207
|
+
/** Number of sample points at each time point */
|
|
208
|
+
dimensions: number;
|
|
209
|
+
/** Decimal values with spaces, or "E" | "U" | "L" */
|
|
210
|
+
data?: string;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* A time period defined by a start and end date and optionally time
|
|
214
|
+
* Based on [FHIR Period](https://www.hl7.org/fhir/R4/datatypes.html#Period)
|
|
215
|
+
*/
|
|
216
|
+
export interface PeriodOutput extends ElementOutput {
|
|
217
|
+
/** Starting time with inclusive boundary */
|
|
218
|
+
start?: string;
|
|
219
|
+
/** End time with inclusive boundary, if not ongoing */
|
|
220
|
+
end?: string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* A reference from one resource to another
|
|
224
|
+
* Based on [FHIR Reference](https://www.hl7.org/fhir/R4/references.html)
|
|
225
|
+
*/
|
|
226
|
+
export interface ReferenceOutput extends ElementOutput {
|
|
227
|
+
/** Literal reference, Relative, internal or absolute URL */
|
|
228
|
+
reference?: string;
|
|
229
|
+
/** Type the reference refers to (e.g. "Patient") */
|
|
230
|
+
type?: string;
|
|
231
|
+
/** Logical reference, when literal reference is not known */
|
|
232
|
+
identifier?: IdentifierOutput;
|
|
233
|
+
/** Text alternative for the resource */
|
|
234
|
+
display?: string;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* An identifier intended for computation
|
|
238
|
+
* Based on [FHIR Identifier](https://www.hl7.org/fhir/R4/identifier.html)
|
|
239
|
+
*/
|
|
240
|
+
export interface IdentifierOutput extends ElementOutput {
|
|
241
|
+
/** usual | official | temp | secondary | old (If known) */
|
|
242
|
+
use?: string;
|
|
243
|
+
/** Description of identifier */
|
|
244
|
+
type?: CodeableConceptOutput;
|
|
245
|
+
/** The namespace for the identifier value */
|
|
246
|
+
system?: string;
|
|
247
|
+
/** The value that is unique */
|
|
248
|
+
value?: string;
|
|
249
|
+
/** Time period when id is/was valid for use */
|
|
250
|
+
period?: PeriodOutput;
|
|
251
|
+
/** Organization that issued id (may be just text) */
|
|
252
|
+
assigner?: ReferenceOutput;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* 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.
|
|
256
|
+
* Based on [FHIR Narrative](https://www.hl7.org/fhir/R4/narrative.html#Narrative)
|
|
257
|
+
*/
|
|
258
|
+
export interface NarrativeOutput extends ElementOutput {
|
|
259
|
+
/** generated, extensions, additional, empty */
|
|
260
|
+
status: string;
|
|
261
|
+
/** xhtml */
|
|
262
|
+
div: string;
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* A text note which also contains information about who made the statement and when
|
|
266
|
+
* Based on [FHIR Annotation](https://www.hl7.org/fhir/R4/datatypes.html#Annotation)
|
|
267
|
+
*/
|
|
268
|
+
export interface AnnotationOutput extends ElementOutput {
|
|
269
|
+
/** Individual responsible for the annotation */
|
|
270
|
+
authorString?: string;
|
|
271
|
+
/** When the annotation was made */
|
|
272
|
+
time?: string;
|
|
273
|
+
/** The annotation - text content (as markdown) */
|
|
274
|
+
text: string;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* Component results
|
|
278
|
+
* Based on [FHIR Observation.component](https://www.hl7.org/fhir/R4/observation.html)
|
|
279
|
+
*/
|
|
280
|
+
export interface ObservationComponentOutput extends ElementOutput {
|
|
281
|
+
/** Type of component observation (code / type) */
|
|
282
|
+
code: CodeableConceptOutput;
|
|
283
|
+
/** Value as Quantity */
|
|
284
|
+
valueQuantity?: QuantityOutput;
|
|
285
|
+
/** Value as CodeableConcept */
|
|
286
|
+
valueCodeableConcept?: CodeableConceptOutput;
|
|
287
|
+
/** Value as string */
|
|
288
|
+
valueString?: string;
|
|
289
|
+
/** Value as boolean */
|
|
290
|
+
valueBoolean?: boolean;
|
|
291
|
+
/** Value as integer */
|
|
292
|
+
valueInteger?: number;
|
|
293
|
+
/** Value as Range. */
|
|
294
|
+
valueRange?: RangeOutput;
|
|
295
|
+
/** Value as Ratio. */
|
|
296
|
+
valueRatio?: RatioOutput;
|
|
297
|
+
/** Value as SampledData. */
|
|
298
|
+
valueSampledData?: SampledDataOutput;
|
|
299
|
+
/** Value as time (hh:mm:ss) */
|
|
300
|
+
valueTime?: string;
|
|
301
|
+
/** Value as dateTime. */
|
|
302
|
+
valueDateTime?: string;
|
|
303
|
+
/** Value as Period. */
|
|
304
|
+
valuePeriod?: PeriodOutput;
|
|
305
|
+
/** Value as reference. */
|
|
306
|
+
valueReference?: ReferenceOutput;
|
|
307
|
+
/** Why the component result is missing */
|
|
308
|
+
dataAbsentReason?: CodeableConceptOutput;
|
|
309
|
+
/** High, low, normal, etc. */
|
|
310
|
+
interpretation?: Array<CodeableConceptOutput>;
|
|
311
|
+
/** Provides guide for interpretation of component result */
|
|
312
|
+
referenceRange?: Array<ObservationReferenceRangeOutput>;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* Provides guide for interpretation of component result
|
|
316
|
+
* Based on [FHIR Observation.referenceRange](https://www.hl7.org/fhir/R4/observation.html)
|
|
317
|
+
*/
|
|
318
|
+
export interface ObservationReferenceRangeOutput {
|
|
319
|
+
/** Low Range, if relevant */
|
|
320
|
+
low?: QuantityOutput;
|
|
321
|
+
/** High Range, if relevant */
|
|
322
|
+
high?: QuantityOutput;
|
|
323
|
+
/** Reference range qualifier */
|
|
324
|
+
type?: CodeableConceptOutput;
|
|
325
|
+
/** Reference range population */
|
|
326
|
+
appliesTo?: Array<CodeableConceptOutput>;
|
|
327
|
+
/** Applicable age range, if relevant */
|
|
328
|
+
age?: RangeOutput;
|
|
329
|
+
/** Text based reference range in an observation */
|
|
330
|
+
text?: string;
|
|
331
|
+
}
|
|
332
|
+
/** Contact details (See: https://www.hl7.org/fhir/R4/metadatatypes.html#ContactDetail) */
|
|
333
|
+
export interface ContactDetailOutput extends ElementOutput {
|
|
334
|
+
/** Name of an individual to contact */
|
|
335
|
+
name?: string;
|
|
336
|
+
/** Contact details for individual or organization */
|
|
337
|
+
telecom?: Array<ContactPointOutput>;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
|
|
341
|
+
* See https://www.hl7.org/fhir/R4/datatypes.html#ContactPoint
|
|
342
|
+
*/
|
|
343
|
+
export interface ContactPointOutput {
|
|
344
|
+
/**
|
|
345
|
+
* phone | fax | email | pager | url | sms | other
|
|
346
|
+
*
|
|
347
|
+
* Possible values: "phone", "fax", "email", "pager", "url", "sms", "other"
|
|
348
|
+
*/
|
|
349
|
+
system?: ContactPointSystemOutput;
|
|
350
|
+
/** The actual contact point details */
|
|
351
|
+
value?: string;
|
|
352
|
+
/**
|
|
353
|
+
* home | work | temp | old | mobile - purpose of this contact point
|
|
354
|
+
*
|
|
355
|
+
* Possible values: "home", "work", "temp", "old", "mobile"
|
|
356
|
+
*/
|
|
357
|
+
use?: ContactPointUseOutput;
|
|
358
|
+
/** Specify preferred order of use (1 = highest) */
|
|
359
|
+
rank?: number;
|
|
360
|
+
/** Time period when the contact point was/is in use */
|
|
361
|
+
period?: PeriodOutput;
|
|
362
|
+
}
|
|
363
|
+
/** A resource with narrative, extensions, and contained resources Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html) */
|
|
364
|
+
export interface DomainResourceOutputParent extends ResourceOutput {
|
|
365
|
+
/** Contained, inline Resources */
|
|
366
|
+
contained?: Array<ResourceOutput>;
|
|
367
|
+
/** Additional Content defined by implementations */
|
|
368
|
+
extension?: Array<ExtensionOutput>;
|
|
369
|
+
/** Extensions that cannot be ignored */
|
|
370
|
+
modifierExtension?: Array<ExtensionOutput>;
|
|
371
|
+
/** resourceType */
|
|
372
|
+
resourceType: string;
|
|
373
|
+
/** Text summary of the resource, for human interpretation */
|
|
374
|
+
text?: NarrativeOutput;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* Detailed information about observations
|
|
378
|
+
* Based on [FHIR Observation](https://www.hl7.org/fhir/R4/observation.html)
|
|
379
|
+
*/
|
|
380
|
+
export interface ObservationOutput extends DomainResourceOutputParent {
|
|
381
|
+
/** resourceType */
|
|
382
|
+
resourceType: "Observation";
|
|
383
|
+
/** Business Identifier for observation */
|
|
384
|
+
identifier?: Array<IdentifierOutput>;
|
|
385
|
+
/**
|
|
386
|
+
* registered | preliminary | final | amended +
|
|
387
|
+
*
|
|
388
|
+
* Possible values: "registered", "preliminary", "final", "amended", "corrected", "cancelled", "entered-in-error", "unknown"
|
|
389
|
+
*/
|
|
390
|
+
status: ObservationStatusCodeTypeOutput;
|
|
391
|
+
/** Classification of type of observation */
|
|
392
|
+
category?: Array<CodeableConceptOutput>;
|
|
393
|
+
/** Type of observation (code / type) */
|
|
394
|
+
code: CodeableConceptOutput;
|
|
395
|
+
/** Who and/or what the observation is about */
|
|
396
|
+
subject?: ReferenceOutput;
|
|
397
|
+
/** Healthcare event during which this observation is made */
|
|
398
|
+
encounter?: ReferenceOutput;
|
|
399
|
+
/** Clinically relevant time/time-period for observation */
|
|
400
|
+
effectiveDateTime?: string;
|
|
401
|
+
/** Clinically relevant time/time-period for observation */
|
|
402
|
+
effectivePeriod?: PeriodOutput;
|
|
403
|
+
/** Clinically relevant time/time-period for observation */
|
|
404
|
+
effectiveInstant?: string;
|
|
405
|
+
/** Date/Time this version was made available */
|
|
406
|
+
issued?: string;
|
|
407
|
+
/** Actual result */
|
|
408
|
+
valueQuantity?: QuantityOutput;
|
|
409
|
+
/** Actual result */
|
|
410
|
+
valueCodeableConcept?: CodeableConceptOutput;
|
|
411
|
+
/** Actual result */
|
|
412
|
+
valueString?: string;
|
|
413
|
+
/** Actual result */
|
|
414
|
+
valueBoolean?: boolean;
|
|
415
|
+
/** Actual result */
|
|
416
|
+
valueInteger?: number;
|
|
417
|
+
/** Actual result */
|
|
418
|
+
valueRange?: RangeOutput;
|
|
419
|
+
/** Actual result */
|
|
420
|
+
valueRatio?: RatioOutput;
|
|
421
|
+
/** Actual result */
|
|
422
|
+
valueSampledData?: SampledDataOutput;
|
|
423
|
+
/** Actual result */
|
|
424
|
+
valueTime?: string;
|
|
425
|
+
/** Actual result */
|
|
426
|
+
valueDateTime?: string;
|
|
427
|
+
/** Actual result */
|
|
428
|
+
valuePeriod?: PeriodOutput;
|
|
429
|
+
/** Why the result is missing */
|
|
430
|
+
dataAbsentReason?: CodeableConceptOutput;
|
|
431
|
+
/** High, low, normal, etc. */
|
|
432
|
+
interpretation?: Array<CodeableConceptOutput>;
|
|
433
|
+
/** Comments about the observation */
|
|
434
|
+
note?: Array<AnnotationOutput>;
|
|
435
|
+
/** Observed body part */
|
|
436
|
+
bodySite?: CodeableConceptOutput;
|
|
437
|
+
/** How it was done */
|
|
438
|
+
method?: CodeableConceptOutput;
|
|
439
|
+
/** Provides guide for interpretation */
|
|
440
|
+
referenceRange?: Array<ObservationReferenceRangeOutput>;
|
|
441
|
+
/** Related resource that belongs to the Observation group */
|
|
442
|
+
hasMember?: Array<ReferenceOutput>;
|
|
443
|
+
/** Related measurements the observation is made from */
|
|
444
|
+
derivedFrom?: Array<ReferenceOutput>;
|
|
445
|
+
/** Component results */
|
|
446
|
+
component?: Array<ObservationComponentOutput>;
|
|
447
|
+
}
|
|
448
|
+
/**
|
|
449
|
+
* Detailed information about conditions, problems or diagnoses
|
|
450
|
+
* Based on [FHIR Condition](https://www.hl7.org/fhir/R4/condition.html)
|
|
451
|
+
*/
|
|
452
|
+
export interface ConditionOutput extends DomainResourceOutputParent {
|
|
453
|
+
/** resourceType */
|
|
454
|
+
resourceType: "Condition";
|
|
455
|
+
/** External Ids for this condition */
|
|
456
|
+
identifier?: Array<IdentifierOutput>;
|
|
457
|
+
/** active | recurrence | relapse | inactive | remission | resolved */
|
|
458
|
+
clinicalStatus?: CodeableConceptOutput;
|
|
459
|
+
/** unconfirmed | provisional | differential | confirmed | refuted | entered-in-error */
|
|
460
|
+
verificationStatus?: CodeableConceptOutput;
|
|
461
|
+
/** problem-list-item | encounter-diagnosis */
|
|
462
|
+
category?: Array<CodeableConceptOutput>;
|
|
463
|
+
/** Subjective severity of condition */
|
|
464
|
+
severity?: CodeableConceptOutput;
|
|
465
|
+
/** Identification of the condition, problem or diagnosis */
|
|
466
|
+
code?: CodeableConceptOutput;
|
|
467
|
+
/** Anatomical location, if relevant */
|
|
468
|
+
bodySite?: Array<CodeableConceptOutput>;
|
|
469
|
+
/** Encounter created as part of */
|
|
470
|
+
encounter?: ReferenceOutput;
|
|
471
|
+
/** Estimated or actual date, date-time, or age */
|
|
472
|
+
onsetDateTime?: string;
|
|
473
|
+
/** Estimated or actual date, date-time, or age */
|
|
474
|
+
onsetAge?: QuantityOutput;
|
|
475
|
+
/** Estimated or actual date, date-time, or age */
|
|
476
|
+
onsetPeriod?: PeriodOutput;
|
|
477
|
+
/** Estimated or actual date, date-time, or age */
|
|
478
|
+
onsetRange?: RangeOutput;
|
|
479
|
+
/** Estimated or actual date, date-time, or age */
|
|
480
|
+
onsetString?: string;
|
|
481
|
+
/** When in resolution/remission */
|
|
482
|
+
abatementDateTime?: string;
|
|
483
|
+
/** When in resolution/remission */
|
|
484
|
+
abatementAge?: QuantityOutput;
|
|
485
|
+
/** When in resolution/remission */
|
|
486
|
+
abatementPeriod?: PeriodOutput;
|
|
487
|
+
/** When in resolution/remission */
|
|
488
|
+
abatementRange?: RangeOutput;
|
|
489
|
+
/** When in resolution/remission */
|
|
490
|
+
abatementString?: string;
|
|
491
|
+
/** Date record was first recorded */
|
|
492
|
+
recordedDate?: string;
|
|
493
|
+
/** stge/grade, usually assessed formally */
|
|
494
|
+
stage?: Array<ConditionStageOutput>;
|
|
495
|
+
/** Additional information about the Condition */
|
|
496
|
+
note?: Array<AnnotationOutput>;
|
|
497
|
+
}
|
|
498
|
+
/**
|
|
499
|
+
* Stage/grade, usually assessed formally
|
|
500
|
+
* Based on [FHIR Condition.Stage](https://www.hl7.org/fhir/R4/condition.html)
|
|
501
|
+
*/
|
|
502
|
+
export interface ConditionStageOutput {
|
|
503
|
+
/** Simple summary (disease specific) */
|
|
504
|
+
summary?: CodeableConceptOutput;
|
|
505
|
+
/** Kind of staging */
|
|
506
|
+
type?: CodeableConceptOutput;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* Detailed information about Research Study
|
|
510
|
+
* Based on [FHIR ResearchStudy](https://www.hl7.org/fhir/R4/researchstudy.html)
|
|
511
|
+
*/
|
|
512
|
+
export interface ResearchStudyOutput extends DomainResourceOutputParent {
|
|
513
|
+
/** resourceType */
|
|
514
|
+
resourceType: "ResearchStudy";
|
|
515
|
+
/** Business Identifier for study */
|
|
516
|
+
identifier?: Array<IdentifierOutput>;
|
|
517
|
+
/** Name for this study */
|
|
518
|
+
title?: string;
|
|
519
|
+
/** Steps followed in executing study */
|
|
520
|
+
protocol?: Array<ReferenceOutput>;
|
|
521
|
+
/** Part of larger study */
|
|
522
|
+
partOf?: Array<ReferenceOutput>;
|
|
523
|
+
/**
|
|
524
|
+
* 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
|
|
525
|
+
*
|
|
526
|
+
* Possible values: "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"
|
|
527
|
+
*/
|
|
528
|
+
status: ResearchStudyStatusCodeTypeOutput;
|
|
529
|
+
/** treatment | prevention | diagnostic | supportive-care | screening | health-services-research | basic-science | device-feasibility */
|
|
530
|
+
primaryPurposeType?: CodeableConceptOutput;
|
|
531
|
+
/** n-a | early-phase-1 | phase-1 | phase-1-phase-2 | phase-2 | phase-2-phase-3 | phase-3 | phase-4 */
|
|
532
|
+
phase?: CodeableConceptOutput;
|
|
533
|
+
/** Classifications for the study */
|
|
534
|
+
category?: Array<CodeableConceptOutput>;
|
|
535
|
+
/** Drugs, devices, etc. under study */
|
|
536
|
+
focus?: Array<CodeableConceptOutput>;
|
|
537
|
+
/** Condition being studied */
|
|
538
|
+
condition?: Array<CodeableConceptOutput>;
|
|
539
|
+
/** Contact details for the study */
|
|
540
|
+
contact?: Array<ContactDetailOutput>;
|
|
541
|
+
/** Used to search for the study */
|
|
542
|
+
keyword?: Array<CodeableConceptOutput>;
|
|
543
|
+
/** Geographic region(s) for study */
|
|
544
|
+
location?: Array<CodeableConceptOutput>;
|
|
545
|
+
/** What this is study doing */
|
|
546
|
+
description?: string;
|
|
547
|
+
/** Inclusion & exclusion criteria */
|
|
548
|
+
enrollment?: Array<ReferenceOutput>;
|
|
549
|
+
/** When the study began and ended */
|
|
550
|
+
period?: PeriodOutput;
|
|
551
|
+
/** Organization that initiates and is legally responsible for the study */
|
|
552
|
+
sponsor?: ReferenceOutput;
|
|
553
|
+
/** Researcher who oversees multiple aspects of the study */
|
|
554
|
+
principalInvestigator?: ReferenceOutput;
|
|
555
|
+
/** Facility where study activities are conducted */
|
|
556
|
+
site?: Array<ReferenceOutput>;
|
|
557
|
+
/** accrual-goal-met | closed-due-to-toxicity | closed-due-to-lack-of-study-progress | temporarily-closed-per-study-design */
|
|
558
|
+
reasonStopped?: CodeableConceptOutput;
|
|
559
|
+
/** Comments made about the study */
|
|
560
|
+
note?: Array<AnnotationOutput>;
|
|
561
|
+
/** Defined path through the study for a subject */
|
|
562
|
+
arm?: {
|
|
563
|
+
name: string;
|
|
564
|
+
type?: CodeableConceptOutput;
|
|
565
|
+
description?: string;
|
|
566
|
+
}[];
|
|
567
|
+
/** A goal for the study */
|
|
568
|
+
objective?: {
|
|
569
|
+
name: string;
|
|
570
|
+
type?: CodeableConceptOutput;
|
|
571
|
+
}[];
|
|
572
|
+
}
|
|
573
|
+
/** visit/encounter information */
|
|
574
|
+
export interface PatientEncounterOutput {
|
|
575
|
+
/** The id of the visit. */
|
|
576
|
+
id: string;
|
|
577
|
+
/**
|
|
578
|
+
* Time period of the visit.
|
|
579
|
+
* In case of admission, use timePeriod.start to indicate the admission time and timePeriod.end to indicate the discharge time.
|
|
580
|
+
*/
|
|
581
|
+
period?: TimePeriodOutput;
|
|
582
|
+
/**
|
|
583
|
+
* The class of the encounter.
|
|
584
|
+
*
|
|
585
|
+
* Possible values: "inpatient", "ambulatory", "observation", "emergency", "virtual", "healthHome"
|
|
586
|
+
*/
|
|
587
|
+
class?: EncounterClassOutput;
|
|
588
|
+
}
|
|
589
|
+
/** A duration of time during which an event is happening */
|
|
590
|
+
export interface TimePeriodOutput {
|
|
591
|
+
/** Starting time with inclusive boundary */
|
|
592
|
+
start?: string;
|
|
593
|
+
/** End time with inclusive boundary, if not ongoing */
|
|
594
|
+
end?: string;
|
|
595
|
+
}
|
|
596
|
+
/** A clinical document related to a patient. Document here is in the wide sense - not just a text document (note). */
|
|
597
|
+
export interface PatientDocumentOutput {
|
|
598
|
+
/**
|
|
599
|
+
* The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).
|
|
600
|
+
*
|
|
601
|
+
* Possible values: "note", "fhirBundle", "dicom", "genomicSequencing"
|
|
602
|
+
*/
|
|
603
|
+
type: DocumentTypeOutput;
|
|
604
|
+
/**
|
|
605
|
+
* The type of the clinical document.
|
|
606
|
+
*
|
|
607
|
+
* Possible values: "consultation", "dischargeSummary", "historyAndPhysical", "radiologyReport", "procedure", "progress", "laboratory", "pathologyReport"
|
|
608
|
+
*/
|
|
609
|
+
clinicalType?: ClinicalDocumentTypeOutput;
|
|
610
|
+
/** A given identifier for the document. Has to be unique across all documents for a single patient. */
|
|
611
|
+
id: string;
|
|
612
|
+
/** A 2 letter ISO 639-1 representation of the language of the document. */
|
|
613
|
+
language?: string;
|
|
614
|
+
/** The date and time when the document was created. */
|
|
615
|
+
createdAt?: string;
|
|
616
|
+
/** Document author(s) */
|
|
617
|
+
authors?: Array<DocumentAuthorOutput>;
|
|
618
|
+
/**
|
|
619
|
+
* specialty type the document
|
|
620
|
+
*
|
|
621
|
+
* Possible values: "pathology", "radiology"
|
|
622
|
+
*/
|
|
623
|
+
specialtyType?: SpecialtyTypeOutput;
|
|
624
|
+
/** Administrative metadata for the document. */
|
|
625
|
+
administrativeMetadata?: DocumentAdministrativeMetadataOutput;
|
|
626
|
+
/** The content of the patient document. */
|
|
627
|
+
content: DocumentContentOutput;
|
|
628
|
+
}
|
|
629
|
+
/** Document author */
|
|
630
|
+
export interface DocumentAuthorOutput {
|
|
631
|
+
/** author id */
|
|
632
|
+
id?: string;
|
|
633
|
+
/** Text representation of the full name */
|
|
634
|
+
fullName?: string;
|
|
635
|
+
}
|
|
636
|
+
/** Document administrative metadata */
|
|
637
|
+
export interface DocumentAdministrativeMetadataOutput {
|
|
638
|
+
/** List of procedure information associated with the document. */
|
|
639
|
+
orderedProcedures?: Array<OrderedProcedureOutput>;
|
|
640
|
+
/** Reference to the encounter associated with the document. */
|
|
641
|
+
encounterId?: string;
|
|
642
|
+
}
|
|
643
|
+
/** Procedure information */
|
|
644
|
+
export interface OrderedProcedureOutput {
|
|
645
|
+
/** Procedure code */
|
|
646
|
+
code?: CodeableConceptOutput;
|
|
647
|
+
/** Procedure description */
|
|
648
|
+
description?: string;
|
|
649
|
+
/** Additional Content defined by implementations */
|
|
650
|
+
extension?: Array<ExtensionOutput>;
|
|
651
|
+
}
|
|
652
|
+
/** The content of the patient document. */
|
|
653
|
+
export interface DocumentContentOutput {
|
|
654
|
+
/**
|
|
655
|
+
* The type of the content's source.
|
|
656
|
+
* In case the source type is 'inline', the content is given as a string (for instance, text).
|
|
657
|
+
* In case the source type is 'reference', the content is given as a URI.
|
|
658
|
+
*
|
|
659
|
+
* Possible values: "inline", "reference"
|
|
660
|
+
*/
|
|
661
|
+
sourceType: DocumentContentSourceTypeOutput;
|
|
662
|
+
/** The content of the document, given either inline (as a string) or as a reference (URI). */
|
|
663
|
+
value: string;
|
|
664
|
+
}
|
|
665
|
+
/** Configuration affecting the Radiology Insights model's inference. */
|
|
666
|
+
export interface RadiologyInsightsModelConfigurationOutput {
|
|
667
|
+
/** An indication whether the model should produce verbose output. */
|
|
668
|
+
verbose?: boolean;
|
|
669
|
+
/** An indication whether the model's output should include evidence for the inferences. */
|
|
670
|
+
includeEvidence?: boolean;
|
|
671
|
+
/** 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. */
|
|
672
|
+
inferenceTypes?: RadiologyInsightsInferenceTypeOutput[];
|
|
673
|
+
/** Options regarding follow up recommendation inferences and finding inferences. */
|
|
674
|
+
inferenceOptions?: RadiologyInsightsInferenceOptionsOutput;
|
|
675
|
+
/** Local for the model to use. If not specified, the model will use the default locale. */
|
|
676
|
+
locale?: string;
|
|
677
|
+
}
|
|
678
|
+
/** Options regarding follow up recommendation inferences and finding inferences. */
|
|
679
|
+
export interface RadiologyInsightsInferenceOptionsOutput {
|
|
680
|
+
/** Follow-up recommendation options. */
|
|
681
|
+
followupRecommendationOptions?: FollowupRecommendationOptionsOutput;
|
|
682
|
+
/** Finding options. */
|
|
683
|
+
findingOptions?: FindingOptionsOutput;
|
|
684
|
+
/** Guidance options. */
|
|
685
|
+
guidanceOptions?: GuidanceOptionsOutput;
|
|
686
|
+
/** QualityMeasureOptions. */
|
|
687
|
+
qualityMeasureOptions?: QualityMeasureOptionsOutput;
|
|
688
|
+
}
|
|
689
|
+
/** Follow-up recommendation options. */
|
|
690
|
+
export interface FollowupRecommendationOptionsOutput {
|
|
691
|
+
/** Include/Exclude follow-up recommendations without a specific radiology procedure. Default is false. */
|
|
692
|
+
includeRecommendationsWithNoSpecifiedModality?: boolean;
|
|
693
|
+
/** Include/Exclude follow-up recommendations in references to a guideline or article. Default is false. */
|
|
694
|
+
includeRecommendationsInReferences?: boolean;
|
|
695
|
+
/** 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. */
|
|
696
|
+
provideFocusedSentenceEvidence?: boolean;
|
|
697
|
+
}
|
|
698
|
+
/** Finding options. */
|
|
699
|
+
export interface FindingOptionsOutput {
|
|
700
|
+
/** 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. */
|
|
701
|
+
provideFocusedSentenceEvidence?: boolean;
|
|
702
|
+
}
|
|
703
|
+
/** Guidance options. */
|
|
704
|
+
export interface GuidanceOptionsOutput {
|
|
705
|
+
/** If this is true, also show guidances from a clinical history section i.e. if the first token of the associated finding's clinical indicator is in this section. Default is false. */
|
|
706
|
+
showGuidanceInHistory: boolean;
|
|
707
|
+
}
|
|
708
|
+
/** Quality Measure Options. */
|
|
709
|
+
export interface QualityMeasureOptionsOutput {
|
|
710
|
+
/** Id(s) of the MIPS measures that need to be evaluated in the document */
|
|
711
|
+
measureTypes: QualityMeasureTypeOutput[];
|
|
712
|
+
}
|
|
713
|
+
/** The inference results for the Radiology Insights request. If field 'status' has value 'succeeded', then field 'result' will contain an instance of RadiologyInsightsInferenceResult. */
|
|
714
|
+
export interface RadiologyInsightsInferenceResultOutput {
|
|
715
|
+
/** Results for the patients given in the request. */
|
|
716
|
+
patientResults: Array<RadiologyInsightsPatientResultOutput>;
|
|
717
|
+
/** The version of the model used for inference, expressed as the model date. */
|
|
718
|
+
modelVersion: string;
|
|
719
|
+
}
|
|
720
|
+
/** Results of the model's work for a single patient. */
|
|
721
|
+
export interface RadiologyInsightsPatientResultOutput {
|
|
722
|
+
/** Identifier given for the patient in the request. */
|
|
723
|
+
patientId: string;
|
|
724
|
+
/** The model's inferences for the given patient. */
|
|
725
|
+
inferences: Array<RadiologyInsightsInferenceOutput>;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* An inference made by the Radiology Insights model regarding a patient.
|
|
729
|
+
* - AgeMismatch
|
|
730
|
+
* - SexMismatch
|
|
731
|
+
* - LateralityDiscrepancy
|
|
732
|
+
* - CompleteOrderDiscrepancy
|
|
733
|
+
* - LimitedOrderDiscrepancy
|
|
734
|
+
* - Finding
|
|
735
|
+
* - CriticalResult
|
|
736
|
+
* - FollowupRecommendation
|
|
737
|
+
* - RadiologyProcedure
|
|
738
|
+
* - FollowupCommunication
|
|
739
|
+
* - ScoringAndAssessment
|
|
740
|
+
* - Guidance
|
|
741
|
+
* - QualityMeasure
|
|
742
|
+
*/
|
|
743
|
+
/** An inference made by the Radiology Insights model regarding a patient: AgeMismatch, SexMismatch, LateralityDiscrepancy, CompleteOrderDiscrepancy, LimitedOrderDiscrepancy, Finding, CriticalResult, FollowupRecommendation, RadiologyProcedure, FollowupCommunicatio */
|
|
744
|
+
export interface RadiologyInsightsInferenceOutputParent {
|
|
745
|
+
/** Additional Content defined by implementations */
|
|
746
|
+
extension?: Array<ExtensionOutput>;
|
|
747
|
+
/** The kind of inference*/
|
|
748
|
+
kind: string;
|
|
749
|
+
}
|
|
750
|
+
/** 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. */
|
|
751
|
+
export interface AgeMismatchInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
752
|
+
/** Inference type. */
|
|
753
|
+
kind: "ageMismatch";
|
|
754
|
+
}
|
|
755
|
+
/** 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. */
|
|
756
|
+
export interface SexMismatchInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
757
|
+
/** Inference type. */
|
|
758
|
+
kind: "sexMismatch";
|
|
759
|
+
/** Sex indication : SNOMED CT code for gender finding. */
|
|
760
|
+
sexIndication: CodeableConceptOutput;
|
|
761
|
+
}
|
|
762
|
+
/** 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). */
|
|
763
|
+
export interface LateralityDiscrepancyInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
764
|
+
/** Inference type. */
|
|
765
|
+
kind: "lateralityDiscrepancy";
|
|
766
|
+
/** Laterality indication : SNOMED CT code for laterality qualifier value. */
|
|
767
|
+
lateralityIndication?: CodeableConceptOutput;
|
|
768
|
+
/**
|
|
769
|
+
* Mismatch type : orderLateralityMismatch, textLateralityContradiction, textLateralityMissing.
|
|
770
|
+
*
|
|
771
|
+
* Possible values: "orderLateralityMismatch", "textLateralityContradiction", "textLateralityMissing"
|
|
772
|
+
*/
|
|
773
|
+
discrepancyType: LateralityDiscrepancyTypeOutput;
|
|
774
|
+
}
|
|
775
|
+
/** 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. */
|
|
776
|
+
export interface CompleteOrderDiscrepancyInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
777
|
+
/** Inference type. */
|
|
778
|
+
kind: "completeOrderDiscrepancy";
|
|
779
|
+
/** Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. */
|
|
780
|
+
orderType: CodeableConceptOutput;
|
|
781
|
+
/** List of missing body parts required by a complete order : SNOMED CT codes. */
|
|
782
|
+
missingBodyParts?: Array<CodeableConceptOutput>;
|
|
783
|
+
/** List of missing body parts that require measurement by a complete order : SNOMED CT codes. */
|
|
784
|
+
missingBodyPartMeasurements?: Array<CodeableConceptOutput>;
|
|
785
|
+
}
|
|
786
|
+
/** 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. */
|
|
787
|
+
export interface LimitedOrderDiscrepancyInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
788
|
+
/** Inference type. */
|
|
789
|
+
kind: "limitedOrderDiscrepancy";
|
|
790
|
+
/** Order type : CPT ultrasound complete code for abdomen, retroperitoneal, pelvis or breast. */
|
|
791
|
+
orderType: CodeableConceptOutput;
|
|
792
|
+
/** List of body parts found in the document : SNOMED CT codes. */
|
|
793
|
+
presentBodyParts?: Array<CodeableConceptOutput>;
|
|
794
|
+
/** List of body parts that are measured according to the document : SNOMED CT codes. */
|
|
795
|
+
presentBodyPartMeasurements?: Array<CodeableConceptOutput>;
|
|
796
|
+
}
|
|
797
|
+
/** Findings in a radiology report typically describe abnormalities, lesions, or other notable observations related to the anatomy or pathology of the imaged area. */
|
|
798
|
+
export interface FindingInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
799
|
+
/** Inference type. */
|
|
800
|
+
kind: "finding";
|
|
801
|
+
/** Finding data : contains extensions, fields and components linked with the finding. */
|
|
802
|
+
finding: ObservationOutput;
|
|
803
|
+
}
|
|
804
|
+
/** Critical results refer to findings of utmost importance that may require timely attention due to their potential impact on patient care. */
|
|
805
|
+
export interface CriticalResultInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
806
|
+
/** Inference type. */
|
|
807
|
+
kind: "criticalResult";
|
|
808
|
+
/** The complete Critical Result, as outlined below, will be reused for the recommendation. */
|
|
809
|
+
result: CriticalResultOutput;
|
|
810
|
+
}
|
|
811
|
+
/** Critical Result consists of two properties. */
|
|
812
|
+
export interface CriticalResultOutput {
|
|
813
|
+
/** Description : medical problem. */
|
|
814
|
+
description: string;
|
|
815
|
+
/** Finding linked to the critical result. */
|
|
816
|
+
finding?: ObservationOutput;
|
|
817
|
+
}
|
|
818
|
+
/** Radiology procedures are the specific imaging studies or examinations ordered for the patient, extracted from the document information and text. */
|
|
819
|
+
export interface RadiologyProcedureInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
820
|
+
/** Inference type. */
|
|
821
|
+
kind: "radiologyProcedure";
|
|
822
|
+
/** LOINC codes for the procedure. */
|
|
823
|
+
procedureCodes?: Array<CodeableConceptOutput>;
|
|
824
|
+
/** Imaging procedures. */
|
|
825
|
+
imagingProcedures: Array<ImagingProcedureOutput>;
|
|
826
|
+
/** Ordered procedure information from the document information or text. */
|
|
827
|
+
orderedProcedure: OrderedProcedureOutput;
|
|
828
|
+
}
|
|
829
|
+
/** Imaging procedure. */
|
|
830
|
+
export interface ImagingProcedureOutput {
|
|
831
|
+
/** Modality : SNOMED CT code. */
|
|
832
|
+
modality: CodeableConceptOutput;
|
|
833
|
+
/** Anatomy : SNOMED CT code. */
|
|
834
|
+
anatomy: CodeableConceptOutput;
|
|
835
|
+
/** Laterality : SNOMED CT code. */
|
|
836
|
+
laterality?: CodeableConceptOutput;
|
|
837
|
+
/** Contrast : see RadiologyCodeWithTypes (below). */
|
|
838
|
+
contrast?: RadiologyCodeWithTypesOutput;
|
|
839
|
+
/** View : see RadiologyCodeWithTypes (below). */
|
|
840
|
+
view?: RadiologyCodeWithTypesOutput;
|
|
841
|
+
}
|
|
842
|
+
/** Radiology code with types : used in imaging procedure recommendation for contrast and view. */
|
|
843
|
+
export interface RadiologyCodeWithTypesOutput {
|
|
844
|
+
/** 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. */
|
|
845
|
+
code: CodeableConceptOutput;
|
|
846
|
+
/** 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. */
|
|
847
|
+
types: Array<CodeableConceptOutput>;
|
|
848
|
+
}
|
|
849
|
+
/** Follow-up recommendations offer guidance to healthcare providers on managing and monitoring patients based on the findings of imaging studies. */
|
|
850
|
+
export interface FollowupRecommendationInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
851
|
+
/** Inference type. */
|
|
852
|
+
kind: "followupRecommendation";
|
|
853
|
+
/** Date and time are displayed when the procedure is recommended to be done at a specific point in time. */
|
|
854
|
+
effectiveAt?: string;
|
|
855
|
+
/** The period is shown if a specific period is mentioned, with a start and end date-time. */
|
|
856
|
+
effectivePeriod?: PeriodOutput;
|
|
857
|
+
/** Findings related to the recommendation. */
|
|
858
|
+
findings?: Array<RecommendationFindingOutput>;
|
|
859
|
+
/** 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. */
|
|
860
|
+
isConditional: boolean;
|
|
861
|
+
/** 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. */
|
|
862
|
+
isOption: boolean;
|
|
863
|
+
/** The guideline value indicates whether or not the recommendation is part of a guideline section that compiles all recommendations applicable to various findings. */
|
|
864
|
+
isGuideline: boolean;
|
|
865
|
+
/** 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. */
|
|
866
|
+
isHedging: boolean;
|
|
867
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
868
|
+
recommendedProcedure: ProcedureRecommendationOutput;
|
|
869
|
+
}
|
|
870
|
+
/** Finding reference for recommendation. */
|
|
871
|
+
export interface RecommendationFindingOutput {
|
|
872
|
+
/** Finding linked to a recommendation. */
|
|
873
|
+
finding?: ObservationOutput;
|
|
874
|
+
/** Critical result linked to a recommendation. */
|
|
875
|
+
criticalFinding?: CriticalResultOutput;
|
|
876
|
+
/**
|
|
877
|
+
* Recommendation finding status.
|
|
878
|
+
*
|
|
879
|
+
* Possible values: "present", "differential", "ruleOut", "conditional"
|
|
880
|
+
*/
|
|
881
|
+
recommendationFindingStatus: RecommendationFindingStatusTypeOutput;
|
|
882
|
+
/** Additional Content defined by implementations */
|
|
883
|
+
extension?: Array<ExtensionOutput>;
|
|
884
|
+
}
|
|
885
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
886
|
+
export interface ProcedureRecommendationOutputParent {
|
|
887
|
+
/** Additional Content defined by implementations */
|
|
888
|
+
extension?: Array<ExtensionOutput>;
|
|
889
|
+
/** The kind of procedure recommendation eg. generic or imaging */
|
|
890
|
+
kind: string;
|
|
891
|
+
}
|
|
892
|
+
/** Generic procedure information. */
|
|
893
|
+
export interface GenericProcedureRecommendationOutput extends ProcedureRecommendationOutputParent {
|
|
894
|
+
/** Procedure type : generic. */
|
|
895
|
+
kind: "genericProcedureRecommendation";
|
|
896
|
+
/** Procedure modality : SNOMED CT code. */
|
|
897
|
+
code: CodeableConceptOutput;
|
|
898
|
+
/** Procedure description : MANAGEMENT PROCEDURE (PROCEDURE) or CONSULTATION (PROCEDURE) based on SNOMED CT. */
|
|
899
|
+
description?: string;
|
|
900
|
+
}
|
|
901
|
+
/** Imaging procedures. */
|
|
902
|
+
export interface ImagingProcedureRecommendationOutput extends ProcedureRecommendationOutputParent {
|
|
903
|
+
/** Procedure type : imaging. */
|
|
904
|
+
kind: "imagingProcedureRecommendation";
|
|
905
|
+
/** LOINC codes for the procedure. */
|
|
906
|
+
procedureCodes?: Array<CodeableConceptOutput>;
|
|
907
|
+
/** Imaging procedures. */
|
|
908
|
+
imagingProcedures: Array<ImagingProcedureOutput>;
|
|
909
|
+
}
|
|
910
|
+
/** Follow-up communication involves the exchange of important information, recommendations, or updates between radiologists and other healthcare professionals involved in a patient's care. */
|
|
911
|
+
export interface FollowupCommunicationInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
912
|
+
/** Inference type. */
|
|
913
|
+
kind: "followupCommunication";
|
|
914
|
+
/** Communication date and time. */
|
|
915
|
+
communicatedAt?: string[];
|
|
916
|
+
/** Recipient of the communication. */
|
|
917
|
+
recipient?: MedicalProfessionalTypeOutput[];
|
|
918
|
+
/** Communication was acknowledged. */
|
|
919
|
+
wasAcknowledged: boolean;
|
|
920
|
+
}
|
|
921
|
+
/** Identifies and highlights Risk, Scoring, Assessment and Classifications and correspondent values dictated in a report, e.g. 'BIRADS 5' */
|
|
922
|
+
export interface ScoringAndAssessmentInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
923
|
+
/** Inference type. */
|
|
924
|
+
kind: "scoringAndAssessment";
|
|
925
|
+
/**
|
|
926
|
+
* Category, e.g. BIRADS
|
|
927
|
+
*
|
|
928
|
+
* Possible values: "BIRADS", "C-RADS COLONIC FINDINGS", "CAD-RADS", "LI-RADS", "LUNG-RADS", "NI-RADS", "O-RADS", "PI-RADS", "TI-RADS", "C-RADS EXTRACOLONIC FINDINGS", "LIFETIME BREAST CANCER RISK", "ASCVD RISK", "MODIFIED GAIL MODEL RISK", "TYRER CUSICK MODEL RISK", "AGATSTON SCORE", "10 YEAR CHD RISK", "Z-SCORE", "T-SCORE", "CALCIUM VOLUME SCORE", "US LI-RADS VISUALIZATION SCORE", "US LI-RADS", "CEUS LI-RADS", "TREATMENT RESPONSE LI-RADS", "O-RADS MRI", "CALCIUM MASS SCORE", "RISK OF MALIGNANCY INDEX", "HNPCC MUTATION RISK", "ALBERTA STROKE PROGRAM EARLY CT SCORE", "KELLGREN-LAWRENCE GRADING SCALE", "TONNIS CLASSIFICATION", "CALCIUM SCORE (UNSPECIFIED)", "10 YEAR CHD RISK (OBSERVED AGE)", "10 YEAR CHD RISK (ARTERIAL AGE)", "FRAX SCORE"
|
|
929
|
+
*/
|
|
930
|
+
category: ScoringAndAssessmentCategoryTypeOutput;
|
|
931
|
+
/** The expansion of the category (which is an abbreviation.) */
|
|
932
|
+
categoryDescription: string;
|
|
933
|
+
/** The value. If the value is a range, use field valueRange. */
|
|
934
|
+
singleValue?: string;
|
|
935
|
+
/** The range. */
|
|
936
|
+
rangeValue?: AssessmentValueRangeOutput;
|
|
937
|
+
}
|
|
938
|
+
/** A range of values. */
|
|
939
|
+
export interface AssessmentValueRangeOutput {
|
|
940
|
+
/** The minimum value. */
|
|
941
|
+
minimum: string;
|
|
942
|
+
/** The maximum value. */
|
|
943
|
+
maximum: string;
|
|
944
|
+
}
|
|
945
|
+
/** A guidance inference collects structured information about a specific finding in the report and can possibly propose appropriate follow-up recommendations, based upon established, evidence-based best practices i.e. ACR guidelines. */
|
|
946
|
+
export interface GuidanceInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
947
|
+
/** Inference type. */
|
|
948
|
+
kind: "guidance";
|
|
949
|
+
/** The finding associated with the guidance. */
|
|
950
|
+
finding: FindingInferenceOutput;
|
|
951
|
+
/** The guidance identifier, as a concept */
|
|
952
|
+
identifier: CodeableConceptOutput;
|
|
953
|
+
/** presentGuidanceInformation lists each item of the structured information (e.g. laterality) and corresponding details (left, right, bilateral) that is present in the document. */
|
|
954
|
+
presentGuidanceInformation?: Array<PresentGuidanceInformationOutput>;
|
|
955
|
+
/**
|
|
956
|
+
* See doc of GuidanceRankingType.
|
|
957
|
+
*
|
|
958
|
+
* Possible values: "high", "low"
|
|
959
|
+
*/
|
|
960
|
+
ranking: GuidanceRankingTypeOutput;
|
|
961
|
+
/** The proposed follow-up recommendations, if any. If this is filled, missingGuidanceInformation cannot be filled (and vice versa). */
|
|
962
|
+
recommendationProposals?: Array<FollowupRecommendationInferenceOutput>;
|
|
963
|
+
/** Contains all missing items that are needed to determine follow-up. */
|
|
964
|
+
missingGuidanceInformation?: string[];
|
|
965
|
+
}
|
|
966
|
+
/** An item of the structured information (e.g. laterality or size) and one or more corresponding details (e.g. left or size-value) */
|
|
967
|
+
export interface PresentGuidanceInformationOutput {
|
|
968
|
+
/** The item of the structured information */
|
|
969
|
+
presentGuidanceItem: string;
|
|
970
|
+
/** A list of size values, if the item is about size. */
|
|
971
|
+
sizes?: Array<ObservationOutput>;
|
|
972
|
+
/** The maximum diameter value, if the item is about the maximum diameter. */
|
|
973
|
+
maximumDiameterAsInText?: QuantityOutput;
|
|
974
|
+
/** The list of item values that are mentioned in the report. */
|
|
975
|
+
presentGuidanceValues?: string[];
|
|
976
|
+
/** Additional Content defined by implementations */
|
|
977
|
+
extension?: Array<ExtensionOutput>;
|
|
978
|
+
}
|
|
979
|
+
/** A QualityMeasure inference captures the MIPS ('measure based incentive payment system') quality measure criteria in the document that are used to measure the data completeness. */
|
|
980
|
+
export interface QualityMeasureInferenceOutput extends RadiologyInsightsInferenceOutputParent {
|
|
981
|
+
/** Inference type. */
|
|
982
|
+
kind: "qualityMeasure";
|
|
983
|
+
/** The denominator, which identifies the QualityMeasure kind. */
|
|
984
|
+
qualityMeasureDenominator: string;
|
|
985
|
+
/**
|
|
986
|
+
* The ComplianceType indicates whether the document is compliant for the specified QualityMeasure or not, or if exceptions apply.
|
|
987
|
+
*
|
|
988
|
+
* Possible values: "notEligible", "performanceNotMet", "performanceMet", "denominatorException"
|
|
989
|
+
*/
|
|
990
|
+
complianceType: QualityMeasureComplianceTypeOutput;
|
|
991
|
+
/** List of quality criteria identified in the document, if any. */
|
|
992
|
+
qualityCriteria?: string[];
|
|
993
|
+
}
|
|
994
|
+
/** A response containing error details. */
|
|
995
|
+
export interface HealthInsightsErrorResponseOutput {
|
|
996
|
+
/** The error object. */
|
|
997
|
+
error: ErrorModel;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* A resource with narrative, extensions, and contained resources
|
|
1001
|
+
* Based on [FHIR DomainResource](https://www.hl7.org/fhir/domainresource.html)
|
|
1002
|
+
*/
|
|
1003
|
+
export type DomainResourceOutput = DomainResourceOutputParent | ObservationOutput | ConditionOutput | ResearchStudyOutput;
|
|
1004
|
+
/**
|
|
1005
|
+
* An inference made by the Radiology Insights model regarding a patient.
|
|
1006
|
+
* - AgeMismatch
|
|
1007
|
+
* - SexMismatch
|
|
1008
|
+
* - LateralityDiscrepancy
|
|
1009
|
+
* - CompleteOrderDiscrepancy
|
|
1010
|
+
* - LimitedOrderDiscrepancy
|
|
1011
|
+
* - Finding
|
|
1012
|
+
* - CriticalResult
|
|
1013
|
+
* - FollowupRecommendation
|
|
1014
|
+
* - RadiologyProcedure
|
|
1015
|
+
* - FollowupCommunication
|
|
1016
|
+
* - ScoringAndAssessment
|
|
1017
|
+
* - Guidance
|
|
1018
|
+
* - QualityMeasure
|
|
1019
|
+
*/
|
|
1020
|
+
export type RadiologyInsightsInferenceOutput = RadiologyInsightsInferenceOutputParent | AgeMismatchInferenceOutput | SexMismatchInferenceOutput | LateralityDiscrepancyInferenceOutput | CompleteOrderDiscrepancyInferenceOutput | LimitedOrderDiscrepancyInferenceOutput | FindingInferenceOutput | CriticalResultInferenceOutput | RadiologyProcedureInferenceOutput | FollowupRecommendationInferenceOutput | FollowupCommunicationInferenceOutput | ScoringAndAssessmentInferenceOutput | GuidanceInferenceOutput | QualityMeasureInferenceOutput;
|
|
1021
|
+
/** The procedure recommendation can be a generic procedure or an imaging procedure. */
|
|
1022
|
+
export type ProcedureRecommendationOutput = ProcedureRecommendationOutputParent | GenericProcedureRecommendationOutput | ImagingProcedureRecommendationOutput;
|
|
1023
|
+
/** Alias for PatientSexOutput */
|
|
1024
|
+
export type PatientSexOutput = string;
|
|
1025
|
+
/** Alias for ContactPointSystemOutput */
|
|
1026
|
+
export type ContactPointSystemOutput = string;
|
|
1027
|
+
/** Alias for ContactPointUseOutput */
|
|
1028
|
+
export type ContactPointUseOutput = string;
|
|
1029
|
+
/** Alias for ObservationStatusCodeTypeOutput */
|
|
1030
|
+
export type ObservationStatusCodeTypeOutput = string;
|
|
1031
|
+
/** Alias for ResearchStudyStatusCodeTypeOutput */
|
|
1032
|
+
export type ResearchStudyStatusCodeTypeOutput = string;
|
|
1033
|
+
/** Alias for EncounterClassOutput */
|
|
1034
|
+
export type EncounterClassOutput = string;
|
|
1035
|
+
/** Alias for DocumentTypeOutput */
|
|
1036
|
+
export type DocumentTypeOutput = string;
|
|
1037
|
+
/** Alias for ClinicalDocumentTypeOutput */
|
|
1038
|
+
export type ClinicalDocumentTypeOutput = string;
|
|
1039
|
+
/** Alias for SpecialtyTypeOutput */
|
|
1040
|
+
export type SpecialtyTypeOutput = string;
|
|
1041
|
+
/** Alias for DocumentContentSourceTypeOutput */
|
|
1042
|
+
export type DocumentContentSourceTypeOutput = string;
|
|
1043
|
+
/** Alias for RadiologyInsightsInferenceTypeOutput */
|
|
1044
|
+
export type RadiologyInsightsInferenceTypeOutput = string;
|
|
1045
|
+
/** Alias for QualityMeasureTypeOutput */
|
|
1046
|
+
export type QualityMeasureTypeOutput = string;
|
|
1047
|
+
/** Alias for LateralityDiscrepancyTypeOutput */
|
|
1048
|
+
export type LateralityDiscrepancyTypeOutput = string;
|
|
1049
|
+
/** Alias for RecommendationFindingStatusTypeOutput */
|
|
1050
|
+
export type RecommendationFindingStatusTypeOutput = string;
|
|
1051
|
+
/** Alias for MedicalProfessionalTypeOutput */
|
|
1052
|
+
export type MedicalProfessionalTypeOutput = string;
|
|
1053
|
+
/** Alias for ScoringAndAssessmentCategoryTypeOutput */
|
|
1054
|
+
export type ScoringAndAssessmentCategoryTypeOutput = string;
|
|
1055
|
+
/** Alias for GuidanceRankingTypeOutput */
|
|
1056
|
+
export type GuidanceRankingTypeOutput = string;
|
|
1057
|
+
/** Alias for QualityMeasureComplianceTypeOutput */
|
|
1058
|
+
export type QualityMeasureComplianceTypeOutput = string;
|
|
1059
|
+
/** Alias for JobStatusOutput */
|
|
1060
|
+
export type JobStatusOutput = string;
|
|
1061
|
+
//# sourceMappingURL=outputModels.d.ts.map
|