/
HealthcareEntity.yml
203 lines (175 loc) · 5.37 KB
/
HealthcareEntity.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
### YamlMime:TSType
name: HealthcareEntity
uid: '@azure/ai-text-analytics.HealthcareEntity'
package: '@azure/ai-text-analytics'
summary: >-
A healthcare entity represented as a node in a directed graph where the edges
are
a particular type of relationship between the source and target nodes.
fullName: HealthcareEntity
remarks: ''
isDeprecated: false
type: interface
properties:
- name: assertion
uid: '@azure/ai-text-analytics.HealthcareEntity.assertion'
package: '@azure/ai-text-analytics'
summary: Whether the entity is negated.
fullName: assertion
remarks: ''
isDeprecated: false
syntax:
content: 'assertion?: HealthcareAssertion'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.HealthcareAssertion" />
- name: category
uid: '@azure/ai-text-analytics.HealthcareEntity.category'
package: '@azure/ai-text-analytics'
summary: >-
Defines values for HealthcareEntityCategory.
<xref:KnownHealthcareEntityCategory> can be used interchangeably with
HealthcareEntityCategory,
this enum contains the known values that the service supports.
### Known values supported by the service
**BODY_STRUCTURE**
**AGE**
**GENDER**
**EXAMINATION_NAME**
**DATE**
**DIRECTION**
**FREQUENCY**
**MEASUREMENT_VALUE**
**MEASUREMENT_UNIT**
**RELATIONAL_OPERATOR**
**TIME**
**GENE_OR_PROTEIN**
**VARIANT**
**ADMINISTRATIVE_EVENT**
**CARE_ENVIRONMENT**
**HEALTHCARE_PROFESSION**
**DIAGNOSIS**
**SYMPTOM_OR_SIGN**
**CONDITION_QUALIFIER**
**MEDICATION_CLASS**
**MEDICATION_NAME**
**DOSAGE**
**MEDICATION_FORM**
**MEDICATION_ROUTE**
**FAMILY_RELATION**
**TREATMENT_NAME**
fullName: category
remarks: ''
isDeprecated: false
syntax:
content: 'category: string'
return:
description: ''
type: string
- name: dataSources
uid: '@azure/ai-text-analytics.HealthcareEntity.dataSources'
package: '@azure/ai-text-analytics'
summary: Entity references in known data sources.
fullName: dataSources
remarks: ''
isDeprecated: false
syntax:
content: 'dataSources: EntityDataSource[]'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.EntityDataSource" />[]
- name: normalizedText
uid: '@azure/ai-text-analytics.HealthcareEntity.normalizedText'
package: '@azure/ai-text-analytics'
summary: >-
Normalized name for the entity. For example, the normalized text for
"histologically" is "histologic".
fullName: normalizedText
remarks: ''
isDeprecated: false
syntax:
content: 'normalizedText?: string'
return:
description: ''
type: string
inheritedProperties:
- name: confidenceScore
uid: '@azure/ai-text-analytics.HealthcareEntity.confidenceScore'
package: '@azure/ai-text-analytics'
summary: Confidence score between 0 and 1 of the extracted entity.
fullName: confidenceScore
remarks: ''
isDeprecated: false
syntax:
content: 'confidenceScore: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[Entity.confidenceScore](xref:@azure/ai-text-analytics.Entity.confidenceScore)
- name: length
uid: '@azure/ai-text-analytics.HealthcareEntity.length'
package: '@azure/ai-text-analytics'
summary: >-
Length for the entity text. Use of different 'stringIndexType' values can
affect the length returned.
fullName: length
remarks: ''
isDeprecated: false
syntax:
content: 'length: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[Entity.length](xref:@azure/ai-text-analytics.Entity.length)
- name: offset
uid: '@azure/ai-text-analytics.HealthcareEntity.offset'
package: '@azure/ai-text-analytics'
summary: >-
Start position for the entity text. Use of different 'stringIndexType'
values can affect the offset returned.
fullName: offset
remarks: ''
isDeprecated: false
syntax:
content: 'offset: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[Entity.offset](xref:@azure/ai-text-analytics.Entity.offset)
- name: subCategory
uid: '@azure/ai-text-analytics.HealthcareEntity.subCategory'
package: '@azure/ai-text-analytics'
summary: (Optional) Entity sub type.
fullName: subCategory
remarks: ''
isDeprecated: false
syntax:
content: 'subCategory?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Entity.subCategory](xref:@azure/ai-text-analytics.Entity.subCategory)
- name: text
uid: '@azure/ai-text-analytics.HealthcareEntity.text'
package: '@azure/ai-text-analytics'
summary: Entity text as appears in the request.
fullName: text
remarks: ''
isDeprecated: false
syntax:
content: 'text: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[Entity.text](xref:@azure/ai-text-analytics.Entity.text)
extends: <xref uid="@azure/ai-text-analytics.Entity" />