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

Description

 
Synopsis

Documentation

data ICD10CMAttribute Source #

The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: Direction, System, Organ or Site, and Acuity.

See: newICD10CMAttribute smart constructor.

Constructors

ICD10CMAttribute' 

Fields

  • relationshipScore :: Maybe Double

    The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

  • beginOffset :: Maybe Int

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

  • text :: Maybe Text

    The segment of input text which contains the detected attribute.

  • category :: Maybe ICD10CMEntityType

    The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

  • score :: Maybe Double

    The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

  • traits :: Maybe [ICD10CMTrait]

    The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

  • relationshipType :: Maybe ICD10CMRelationshipType

    The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

  • endOffset :: Maybe Int

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

  • id :: Maybe Int

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

  • type' :: Maybe ICD10CMAttributeType

    The type of attribute. InferICD10CM detects entities of the type DX_NAME.

Instances

Instances details
Eq ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Methods

(==) :: ICD10CMAttribute -> ICD10CMAttribute -> Bool #

(/=) :: ICD10CMAttribute -> ICD10CMAttribute -> Bool #

Read ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Methods

readsPrec :: Int -> ReadS ICD10CMAttribute #

readList :: ReadS [ICD10CMAttribute] #

readPrec :: ReadPrec ICD10CMAttribute #

readListPrec :: ReadPrec [ICD10CMAttribute] #

Show ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Methods

showsPrec :: Int -> ICD10CMAttribute -> ShowS #

show :: ICD10CMAttribute -> String #

showList :: [ICD10CMAttribute] -> ShowS #

Generic ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Associated Types

type Rep ICD10CMAttribute :: Type -> Type #

Methods

from :: ICD10CMAttribute -> Rep ICD10CMAttribute x #

to :: Rep ICD10CMAttribute x -> ICD10CMAttribute #

NFData ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Methods

rnf :: ICD10CMAttribute -> () #

Hashable ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Methods

hashWithSalt :: Int -> ICD10CMAttribute -> Int #

hash :: ICD10CMAttribute -> Int #

FromJSON ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

Methods

parseJSON :: Value -> Parser ICD10CMAttribute #

parseJSONList :: Value -> Parser [ICD10CMAttribute] #

type Rep ICD10CMAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.ICD10CMAttribute

type Rep ICD10CMAttribute = D1 ('MetaData "ICD10CMAttribute" "Amazonka.ComprehendMedical.Types.ICD10CMAttribute" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "ICD10CMAttribute'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "relationshipScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ICD10CMEntityType)) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) :*: ((S1 ('MetaSel ('Just "traits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ICD10CMTrait])) :*: S1 ('MetaSel ('Just "relationshipType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ICD10CMRelationshipType))) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ICD10CMAttributeType)))))))

newICD10CMAttribute :: ICD10CMAttribute Source #

Create a value of ICD10CMAttribute 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:relationshipScore:ICD10CMAttribute', iCD10CMAttribute_relationshipScore - The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

$sel:beginOffset:ICD10CMAttribute', iCD10CMAttribute_beginOffset - The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

$sel:text:ICD10CMAttribute', iCD10CMAttribute_text - The segment of input text which contains the detected attribute.

$sel:category:ICD10CMAttribute', iCD10CMAttribute_category - The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

$sel:score:ICD10CMAttribute', iCD10CMAttribute_score - The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

$sel:traits:ICD10CMAttribute', iCD10CMAttribute_traits - The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

$sel:relationshipType:ICD10CMAttribute', iCD10CMAttribute_relationshipType - The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

$sel:endOffset:ICD10CMAttribute', iCD10CMAttribute_endOffset - The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

$sel:id:ICD10CMAttribute', iCD10CMAttribute_id - The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

$sel:type':ICD10CMAttribute', iCD10CMAttribute_type - The type of attribute. InferICD10CM detects entities of the type DX_NAME.

iCD10CMAttribute_relationshipScore :: Lens' ICD10CMAttribute (Maybe Double) Source #

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

iCD10CMAttribute_beginOffset :: Lens' ICD10CMAttribute (Maybe Int) Source #

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

iCD10CMAttribute_text :: Lens' ICD10CMAttribute (Maybe Text) Source #

The segment of input text which contains the detected attribute.

iCD10CMAttribute_category :: Lens' ICD10CMAttribute (Maybe ICD10CMEntityType) Source #

The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION.

iCD10CMAttribute_score :: Lens' ICD10CMAttribute (Maybe Double) Source #

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

iCD10CMAttribute_traits :: Lens' ICD10CMAttribute (Maybe [ICD10CMTrait]) Source #

The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

iCD10CMAttribute_relationshipType :: Lens' ICD10CMAttribute (Maybe ICD10CMRelationshipType) Source #

The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE.

iCD10CMAttribute_endOffset :: Lens' ICD10CMAttribute (Maybe Int) Source #

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

iCD10CMAttribute_id :: Lens' ICD10CMAttribute (Maybe Int) Source #

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

iCD10CMAttribute_type :: Lens' ICD10CMAttribute (Maybe ICD10CMAttributeType) Source #

The type of attribute. InferICD10CM detects entities of the type DX_NAME.