Amazonka.ComprehendMedical.Types.RxNormAttribute

Documentation

data RxNormAttribute

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

See: newRxNormAttribute smart constructor.

Constructors

RxNormAttribute'

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.

• 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 Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

• 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 which corresponds to the detected attribute.

• traits :: Maybe [RxNormTrait]

  Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

• type' :: Maybe RxNormAttributeType

  The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

Instances

FromJSON RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Methods

parseJSON :: Value -> Parser RxNormAttribute

parseJSONList :: Value -> Parser [RxNormAttribute]

Generic RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Associated Types

type Rep RxNormAttribute :: Type -> Type

Methods

from :: RxNormAttribute -> Rep RxNormAttribute x

to :: Rep RxNormAttribute x -> RxNormAttribute

Read RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Methods

readsPrec :: Int -> ReadS RxNormAttribute

readList :: ReadS [RxNormAttribute]

readPrec :: ReadPrec RxNormAttribute

readListPrec :: ReadPrec [RxNormAttribute]

Show RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Methods

showsPrec :: Int -> RxNormAttribute -> ShowS

show :: RxNormAttribute -> String

showList :: [RxNormAttribute] -> ShowS

NFData RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Methods

rnf :: RxNormAttribute -> ()

Eq RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Methods

(==) :: RxNormAttribute -> RxNormAttribute -> Bool

(/=) :: RxNormAttribute -> RxNormAttribute -> Bool

Hashable RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

Methods

hashWithSalt :: Int -> RxNormAttribute -> Int

hash :: RxNormAttribute -> Int

type Rep RxNormAttribute

Defined in Amazonka.ComprehendMedical.Types.RxNormAttribute

type Rep RxNormAttribute = D1 ('MetaData "RxNormAttribute" "Amazonka.ComprehendMedical.Types.RxNormAttribute" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "RxNormAttribute'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "beginOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: 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 "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 [RxNormTrait])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RxNormAttributeType))))))

newRxNormAttribute :: RxNormAttribute

Create a value of RxNormAttribute 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:RxNormAttribute', rxNormAttribute_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:endOffset:RxNormAttribute', rxNormAttribute_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:RxNormAttribute', rxNormAttribute_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:RxNormAttribute', rxNormAttribute_relationshipScore - The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

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

$sel:text:RxNormAttribute', rxNormAttribute_text - The segment of input text which corresponds to the detected attribute.

$sel:traits:RxNormAttribute', rxNormAttribute_traits - Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

$sel:type':RxNormAttribute', rxNormAttribute_type - The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.

rxNormAttribute_beginOffset :: Lens' RxNormAttribute (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.

rxNormAttribute_endOffset :: Lens' RxNormAttribute (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.

rxNormAttribute_id :: Lens' RxNormAttribute (Maybe Int)

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

rxNormAttribute_relationshipScore :: Lens' RxNormAttribute (Maybe Double)

The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

rxNormAttribute_score :: Lens' RxNormAttribute (Maybe Double)

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

rxNormAttribute_text :: Lens' RxNormAttribute (Maybe Text)

The segment of input text which corresponds to the detected attribute.

rxNormAttribute_traits :: Lens' RxNormAttribute (Maybe [RxNormTrait])

Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.

rxNormAttribute_type :: Lens' RxNormAttribute (Maybe RxNormAttributeType)

The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME.