libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ComprehendMedical.Types.RxNormEntity

Description

 
Synopsis

Documentation

data RxNormEntity 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: newRxNormEntity smart constructor.

Constructors

RxNormEntity' 

Fields

  • rxNormConcepts :: Maybe [RxNormConcept]

    The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

  • 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.

  • text :: Maybe Text

    The segment of input text extracted from which the entity was detected.

  • category :: Maybe RxNormEntityCategory

    The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

  • score :: Maybe Double

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

  • traits :: Maybe [RxNormTrait]

    Contextual information for the entity.

  • attributes :: Maybe [RxNormAttribute]

    The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

  • 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.

  • 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.

  • type' :: Maybe RxNormEntityType

    Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

Instances

Instances details
Eq RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

Read RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

Show RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

Generic RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

Associated Types

type Rep RxNormEntity :: Type -> Type #

NFData RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

Methods

rnf :: RxNormEntity -> () #

Hashable RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

FromJSON RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

type Rep RxNormEntity Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.RxNormEntity

newRxNormEntity :: RxNormEntity Source #

Create a value of RxNormEntity 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:rxNormConcepts:RxNormEntity', rxNormEntity_rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

$sel:beginOffset:RxNormEntity', rxNormEntity_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.

$sel:text:RxNormEntity', rxNormEntity_text - The segment of input text extracted from which the entity was detected.

$sel:category:RxNormEntity', rxNormEntity_category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

$sel:score:RxNormEntity', rxNormEntity_score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

$sel:traits:RxNormEntity', rxNormEntity_traits - Contextual information for the entity.

$sel:attributes:RxNormEntity', rxNormEntity_attributes - The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

$sel:endOffset:RxNormEntity', rxNormEntity_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:id:RxNormEntity', rxNormEntity_id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

$sel:type':RxNormEntity', rxNormEntity_type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

rxNormEntity_rxNormConcepts :: Lens' RxNormEntity (Maybe [RxNormConcept]) Source #

The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

rxNormEntity_beginOffset :: Lens' RxNormEntity (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.

rxNormEntity_text :: Lens' RxNormEntity (Maybe Text) Source #

The segment of input text extracted from which the entity was detected.

rxNormEntity_category :: Lens' RxNormEntity (Maybe RxNormEntityCategory) Source #

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

rxNormEntity_score :: Lens' RxNormEntity (Maybe Double) Source #

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

rxNormEntity_traits :: Lens' RxNormEntity (Maybe [RxNormTrait]) Source #

Contextual information for the entity.

rxNormEntity_attributes :: Lens' RxNormEntity (Maybe [RxNormAttribute]) Source #

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

rxNormEntity_endOffset :: Lens' RxNormEntity (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.

rxNormEntity_id :: Lens' RxNormEntity (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.

rxNormEntity_type :: Lens' RxNormEntity (Maybe RxNormEntityType) Source #

Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.