Skip to content

ICD10CMAttribute

Source code in docs_src/capo_comprehendmedical/types/icd10_cm_attribute.py
class ICD10CMAttribute(TypedDict, closed=True):
    type: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_attribute_type.ICD10CMAttributeType"
    ]
    """<p>The type of attribute. InferICD10CM detects entities of the type <code>DX_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 this attribute is correctly related to this 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 contains the detected attribute.</p>"""
    traits: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_trait_list.ICD10CMTraitList"
    ]
    """<p>The contextual information for the attribute. The traits recognized by InferICD10CM are <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and <code>NEGATION</code>.</p>"""
    category: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_entity_type.ICD10CMEntityType"
    ]
    """<p>The category of attribute. Can be either of <code>DX_NAME</code> or <code>TIME_EXPRESSION</code>.</p>"""
    relationship_type: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_relationship_type.ICD10CMRelationshipType"
    ]
    """<p>The type of relationship between the entity and attribute. Type for the relationship can be either of <code>OVERLAP</code> or <code>SYSTEM_ORGAN_SITE</code>.</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.

category instance-attribute

category: NotRequired[ICD10CMEntityType]

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

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 this attribute is correctly related to this entity.

relationship_type instance-attribute

relationship_type: NotRequired[ICD10CMRelationshipType]

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

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 contains the detected attribute.

traits instance-attribute

traits: NotRequired[ICD10CMTraitList]

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

type instance-attribute

type: NotRequired[ICD10CMAttributeType]

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