Share via

HealthcareEntity interface

  • Reference
Package:
@azure/ai-text-analytics

Warning

This API is now deprecated.

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.

Extends
Entity

Properties

assertion

Whether the entity is negated.
category

Defines values for HealthcareEntityCategory. 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
dataSources

Entity references in known data sources.
normalizedText

Normalized name for the entity. For example, the normalized text for "histologically" is "histologic".

Inherited Properties

confidenceScore

Confidence score between 0 and 1 of the extracted entity.
length

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.
offset

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.
subCategory

(Optional) Entity sub type.
text

Entity text as appears in the request.

Property Details

assertion

Warning

This API is now deprecated.

Whether the entity is negated.

assertion?: EntityAssertion

Property Value

EntityAssertion

category

Warning

This API is now deprecated.

Defines values for HealthcareEntityCategory. 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

category: string

Property Value

string

dataSources

Warning

This API is now deprecated.

Entity references in known data sources.

dataSources: EntityDataSource[]

Property Value

EntityDataSource[]

normalizedText

Warning

This API is now deprecated.

Normalized name for the entity. For example, the normalized text for "histologically" is "histologic".

normalizedText?: string

Property Value

string

Inherited Property Details

confidenceScore

Warning

This API is now deprecated.

Confidence score between 0 and 1 of the extracted entity.

confidenceScore: number

Property Value

number

Inherited From Entity.confidenceScore

length

Warning

This API is now deprecated.

Length for the entity text. Use of different 'stringIndexType' values can affect the length returned.

length: number

Property Value

number

Inherited From Entity.length

offset

Warning

This API is now deprecated.

Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned.

offset: number

Property Value

number

Inherited From Entity.offset

subCategory

(Optional) Entity sub type.

subCategory?: string

Property Value

string

Inherited From Entity.subCategory

text

Warning

This API is now deprecated.

Entity text as appears in the request.

text: string

Property Value

string

Inherited From Entity.text