Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HealthcareEntity

Package version

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.

Hierarchy

Index

Properties

Optional assertion

An object that describes metadata about the healthcare entity such as whether it is hypothetical or conditional. Whether the entity is negated.

category

Healthcare Entity 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

confidenceScore

confidenceScore: number

Confidence score between 0 and 1 of the extracted entity.

Optional dataSources

dataSources: EntityDataSource[]

Entity references in known data sources. Entity references in known data sources.

length

length: number

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

Optional normalizedText

normalizedText: undefined | string

Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'. Normalized name for the entity. For example, the normalized text for "histologically" is "histologic".

offset

offset: number

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

Optional subCategory

subCategory: undefined | string

(Optional) Entity sub type.

text

text: string

Entity text as appears in the request.

Generated using TypeDoc