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

Description

 
Synopsis

Documentation

data SNOMEDCTAttribute Source #

The extracted attributes that relate to an entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken.

See: newSNOMEDCTAttribute smart constructor.

Constructors

SNOMEDCTAttribute' 

Fields

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

  • category :: Maybe SNOMEDCTEntityCategory

    The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

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

  • relationshipScore :: Maybe Double

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

  • relationshipType :: Maybe SNOMEDCTRelationshipType

    The type of relationship that exists between the entity and the related attribute.

  • sNOMEDCTConcepts :: Maybe [SNOMEDCTConcept]

    The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

  • score :: Maybe Double

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

  • text :: Maybe Text

    The segment of input text extracted as this attribute.

  • traits :: Maybe [SNOMEDCTTrait]

    Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

  • type' :: Maybe SNOMEDCTAttributeType

    The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.

Instances

Instances details
FromJSON SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

Generic SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

Associated Types

type Rep SNOMEDCTAttribute :: Type -> Type #

Read SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

Show SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

NFData SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

Methods

rnf :: SNOMEDCTAttribute -> () #

Eq SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

Hashable SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

type Rep SNOMEDCTAttribute Source # 
Instance details

Defined in Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute

type Rep SNOMEDCTAttribute = D1 ('MetaData "SNOMEDCTAttribute" "Amazonka.ComprehendMedical.Types.SNOMEDCTAttribute" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "SNOMEDCTAttribute'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "category") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNOMEDCTEntityCategory))) :*: (S1 ('MetaSel ('Just "endOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "relationshipScore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))) :*: ((S1 ('MetaSel ('Just "relationshipType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNOMEDCTRelationshipType)) :*: (S1 ('MetaSel ('Just "sNOMEDCTConcepts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SNOMEDCTConcept])) :*: S1 ('MetaSel ('Just "score") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "traits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SNOMEDCTTrait])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNOMEDCTAttributeType)))))))

newSNOMEDCTAttribute :: SNOMEDCTAttribute Source #

Create a value of SNOMEDCTAttribute 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:beginOffset:SNOMEDCTAttribute', sNOMEDCTAttribute_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:category:SNOMEDCTAttribute', sNOMEDCTAttribute_category - The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

$sel:endOffset:SNOMEDCTAttribute', sNOMEDCTAttribute_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:SNOMEDCTAttribute', sNOMEDCTAttribute_id - The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

$sel:relationshipScore:SNOMEDCTAttribute', sNOMEDCTAttribute_relationshipScore - The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.

$sel:relationshipType:SNOMEDCTAttribute', sNOMEDCTAttribute_relationshipType - The type of relationship that exists between the entity and the related attribute.

$sel:sNOMEDCTConcepts:SNOMEDCTAttribute', sNOMEDCTAttribute_sNOMEDCTConcepts - The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

SNOMEDCTAttribute, sNOMEDCTAttribute_score - The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.

$sel:text:SNOMEDCTAttribute', sNOMEDCTAttribute_text - The segment of input text extracted as this attribute.

$sel:traits:SNOMEDCTAttribute', sNOMEDCTAttribute_traits - Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

$sel:type':SNOMEDCTAttribute', sNOMEDCTAttribute_type - The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.

sNOMEDCTAttribute_beginOffset :: Lens' SNOMEDCTAttribute (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.

sNOMEDCTAttribute_category :: Lens' SNOMEDCTAttribute (Maybe SNOMEDCTEntityCategory) Source #

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

sNOMEDCTAttribute_endOffset :: Lens' SNOMEDCTAttribute (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.

sNOMEDCTAttribute_id :: Lens' SNOMEDCTAttribute (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.

sNOMEDCTAttribute_relationshipScore :: Lens' SNOMEDCTAttribute (Maybe Double) Source #

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

sNOMEDCTAttribute_relationshipType :: Lens' SNOMEDCTAttribute (Maybe SNOMEDCTRelationshipType) Source #

The type of relationship that exists between the entity and the related attribute.

sNOMEDCTAttribute_sNOMEDCTConcepts :: Lens' SNOMEDCTAttribute (Maybe [SNOMEDCTConcept]) Source #

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

sNOMEDCTAttribute_score :: Lens' SNOMEDCTAttribute (Maybe Double) Source #

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

sNOMEDCTAttribute_text :: Lens' SNOMEDCTAttribute (Maybe Text) Source #

The segment of input text extracted as this attribute.

sNOMEDCTAttribute_traits :: Lens' SNOMEDCTAttribute (Maybe [SNOMEDCTTrait]) Source #

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

sNOMEDCTAttribute_type :: Lens' SNOMEDCTAttribute (Maybe SNOMEDCTAttributeType) Source #

The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.