/
HealthcareSuccessResult.yml
121 lines (117 loc) · 4.12 KB
/
HealthcareSuccessResult.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
### YamlMime:TSType
name: HealthcareSuccessResult
uid: '@azure/ai-text-analytics.HealthcareSuccessResult'
package: '@azure/ai-text-analytics'
summary: The results of a successful healthcare operation for a single document.
fullName: HealthcareSuccessResult
remarks: ''
isDeprecated: false
type: interface
properties:
- name: entities
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.entities'
package: '@azure/ai-text-analytics'
summary: Healthcare entities.
fullName: entities
remarks: ''
isDeprecated: false
syntax:
content: 'entities: HealthcareEntity[]'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.HealthcareEntity" />[]
- name: entityRelations
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.entityRelations'
package: '@azure/ai-text-analytics'
summary: Relations between healthcare entities.
fullName: entityRelations
remarks: ''
isDeprecated: false
syntax:
content: 'entityRelations: HealthcareEntityRelation[]'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.HealthcareEntityRelation" />[]
- name: fhirBundle
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.fhirBundle'
package: '@azure/ai-text-analytics'
summary: >-
JSON bundle containing a FHIR compatible object for consumption in other
Healthcare tools. For additional information see
https://www.hl7.org/fhir/overview.html.
fullName: fhirBundle
remarks: ''
isDeprecated: false
syntax:
content: 'fhirBundle?: Record<string, any>'
return:
description: ''
type: Record<string, any>
inheritedProperties:
- name: error
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.error'
package: '@azure/ai-text-analytics'
summary: Discriminant to determine if this is an error result.
fullName: error
remarks: ''
isDeprecated: false
syntax:
content: 'error?: undefined'
return:
description: ''
type: undefined
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalysisSuccessResult.error](xref:@azure/ai-text-analytics.TextAnalysisSuccessResult.error)
- name: id
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.id'
package: '@azure/ai-text-analytics'
summary: Unique, non-empty document identifier.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalysisSuccessResult.id](xref:@azure/ai-text-analytics.TextAnalysisSuccessResult.id)
- name: statistics
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.statistics'
package: '@azure/ai-text-analytics'
summary: >-
Statistics about the input document and how it was processed by the
service.
This property will have a value when includeStatistics is set to true in
the client call.
fullName: statistics
remarks: ''
isDeprecated: false
syntax:
content: 'statistics?: TextDocumentStatistics'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.TextDocumentStatistics" />
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalysisSuccessResult.statistics](xref:@azure/ai-text-analytics.TextAnalysisSuccessResult.statistics)
- name: warnings
uid: '@azure/ai-text-analytics.HealthcareSuccessResult.warnings'
package: '@azure/ai-text-analytics'
summary: |-
An array of warning data corresponding to this document.
If no warnings were returned, this array will be empty.
fullName: warnings
remarks: ''
isDeprecated: false
syntax:
content: 'warnings: DocumentWarning[]'
return:
description: ''
type: <xref uid="@azure/ai-text-analytics.DocumentWarning" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[TextAnalysisSuccessResult.warnings](xref:@azure/ai-text-analytics.TextAnalysisSuccessResult.warnings)
extends: <xref uid="@azure/ai-text-analytics.TextAnalysisSuccessResult" />