amazonka-comprehendmedical-2.0: Amazon Comprehend Medical SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ComprehendMedical.Types.ICD10CMEntity

Description

 
Synopsis

Documentation

data ICD10CMEntity Source #

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

See: newICD10CMEntity smart constructor.

Constructors

ICD10CMEntity' 

Fields

  • attributes :: Maybe [ICD10CMAttribute]

    The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

  • beginOffset :: Maybe Int

    The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

  • category :: Maybe ICD10CMEntityCategory

    The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

  • endOffset :: Maybe Int

    The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

  • iCD10CMConcepts :: Maybe [ICD10CMConcept]

    The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

  • id :: Maybe Int

    The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

  • score :: Maybe Double

    The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

  • text :: Maybe Text

    The segment of input text that is matched to the detected entity.

  • traits :: Maybe [ICD10CMTrait]

    Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

  • type' :: Maybe ICD10CMEntityType

    Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.

Instances

Instances details
FromJSON ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

Generic ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

Associated Types

type Rep ICD10CMEntity :: Type -> Type #

Read ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

Show ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

NFData ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

Methods

rnf :: ICD10CMEntity -> () #

Eq ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

Hashable ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

type Rep ICD10CMEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMEntity

newICD10CMEntity :: ICD10CMEntity Source #

Create a value of ICD10CMEntity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributes:ICD10CMEntity', iCD10CMEntity_attributes - The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

ICD10CMEntity, iCD10CMEntity_beginOffset - The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

ICD10CMEntity, iCD10CMEntity_category - The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

ICD10CMEntity, iCD10CMEntity_endOffset - The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

$sel:iCD10CMConcepts:ICD10CMEntity', iCD10CMEntity_iCD10CMConcepts - The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

ICD10CMEntity, iCD10CMEntity_id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

ICD10CMEntity, iCD10CMEntity_score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

ICD10CMEntity, iCD10CMEntity_text - The segment of input text that is matched to the detected entity.

ICD10CMEntity, iCD10CMEntity_traits - Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

ICD10CMEntity, iCD10CMEntity_type - Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.

iCD10CMEntity_attributes :: Lens' ICD10CMEntity (Maybe [ICD10CMAttribute]) Source #

The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

iCD10CMEntity_beginOffset :: Lens' ICD10CMEntity (Maybe Int) Source #

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

iCD10CMEntity_category :: Lens' ICD10CMEntity (Maybe ICD10CMEntityCategory) Source #

The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

iCD10CMEntity_endOffset :: Lens' ICD10CMEntity (Maybe Int) Source #

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

iCD10CMEntity_iCD10CMConcepts :: Lens' ICD10CMEntity (Maybe [ICD10CMConcept]) Source #

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

iCD10CMEntity_id :: Lens' ICD10CMEntity (Maybe Int) Source #

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

iCD10CMEntity_score :: Lens' ICD10CMEntity (Maybe Double) Source #

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

iCD10CMEntity_text :: Lens' ICD10CMEntity (Maybe Text) Source #

The segment of input text that is matched to the detected entity.

iCD10CMEntity_traits :: Lens' ICD10CMEntity (Maybe [ICD10CMTrait]) Source #

Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

iCD10CMEntity_type :: Lens' ICD10CMEntity (Maybe ICD10CMEntityType) Source #

Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.