HealthcareSuccessResult interface

Package:

@azure/ai-text-analytics

The results of a successful healthcare operation for a single document.

Extends

TextAnalysisSuccessResult

Properties

entities	Healthcare entities.
entityRelations	Relations between healthcare entities.
fhirBundle	JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.

Inherited Properties

error	Discriminant to determine if this is an error result.
id	Unique, non-empty document identifier.
statistics	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.
warnings	An array of warning data corresponding to this document. If no warnings were returned, this array will be empty.

Property Details

entities

Healthcare entities.

entities: HealthcareEntity[]

Property Value

HealthcareEntity[]

entityRelations

Relations between healthcare entities.

entityRelations: HealthcareEntityRelation[]

Property Value

HealthcareEntityRelation[]

fhirBundle

JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.

fhirBundle?: Record<string, any>

Property Value

Record<string, any>

Inherited Property Details

error

Discriminant to determine if this is an error result.

error?: undefined

Property Value

undefined

Inherited From TextAnalysisSuccessResult.error

id

Unique, non-empty document identifier.

id: string

Property Value

string

Inherited From TextAnalysisSuccessResult.id

statistics

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.

statistics?: TextDocumentStatistics

Property Value

TextDocumentStatistics

Inherited From TextAnalysisSuccessResult.statistics

warnings

An array of warning data corresponding to this document.

If no warnings were returned, this array will be empty.

warnings: DocumentWarning[]

Property Value

DocumentWarning[]

Inherited From TextAnalysisSuccessResult.warnings