Skip to content

RxNormAttribute

Source code in docs_src/capo_comprehendmedical/types/rx_norm_attribute.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class RxNormAttribute(TypedDict, closed=True):
    type: NotRequired[
        "capo_comprehendmedical.types.rx_norm_attribute_type.RxNormAttributeType"
    ]
    """<p>The type of attribute. The types of attributes recognized by InferRxNorm are <code>BRAND_NAME</code> and <code>GENERIC_NAME</code>.</p>"""
    score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p>The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.</p>"""
    relationship_score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p>The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.</p>"""
    id: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p>The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.</p>"""
    begin_offset: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p>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.</p>"""
    end_offset: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p>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.</p>"""
    text: NotRequired["capo_comprehendmedical.types.string.String"]
    """<p>The segment of input text which corresponds to the detected attribute.</p>"""
    traits: NotRequired[
        "capo_comprehendmedical.types.rx_norm_trait_list.RxNormTraitList"
    ]
    """<p>Contextual information for the attribute. InferRxNorm recognizes the trait <code>NEGATION</code> for attributes, i.e. that the patient is not taking a specific dose or form of a medication.</p>"""

begin_offset instance-attribute 

begin_offset: NotRequired[Integer]

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.

end_offset instance-attribute 

end_offset: NotRequired[Integer]

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 instance-attribute 

id: NotRequired[Integer]

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

relationship_score instance-attribute 

relationship_score: NotRequired[Float]

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

score instance-attribute 

score: NotRequired[Float]

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

text instance-attribute 

text: NotRequired[String]

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

traits instance-attribute 

traits: NotRequired[RxNormTraitList]

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 instance-attribute 

type: NotRequired[RxNormAttributeType]

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