Skip to content

ICD10CMEntity

Source code in docs_src/capo_comprehendmedical/types/icd10_cm_entity.py
class ICD10CMEntity(TypedDict, closed=True):
    id: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p>The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.</p>"""
    text: NotRequired[
        "capo_comprehendmedical.types.ontology_linking_bounded_length_string.OntologyLinkingBoundedLengthString"
    ]
    """<p>The segment of input text that is matched to the detected entity.</p>"""
    category: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_entity_category.ICD10CMEntityCategory"
    ]
    """<p> The category of the entity. InferICD10CM detects entities in the <code>MEDICAL_CONDITION</code> category. </p>"""
    type: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_entity_type.ICD10CMEntityType"
    ]
    """<p>Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type <code>DX_NAME</code> and <code>TIME_EXPRESSION</code>.</p>"""
    score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p>The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.</p>"""
    begin_offset: NotRequired["capo_comprehendmedical.types.integer.Integer"]
    """<p>The 0-based character offset in the input text that shows where the entity 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 entity ends. The offset returns the UTF-8 code point in the string.</p>"""
    attributes: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_attribute_list.ICD10CMAttributeList"
    ]
    """<p>The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.</p>"""
    traits: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_trait_list.ICD10CMTraitList"
    ]
    """<p>Provides Contextual information for the entity. The traits recognized by InferICD10CM are <code>DIAGNOSIS</code>, <code>SIGN</code>, <code>SYMPTOM</code>, and <code>NEGATION.</code> </p>"""
    icd10_cm_concepts: NotRequired[
        "capo_comprehendmedical.types.icd10_cm_concept_list.ICD10CMConceptList"
    ]
    """<p>The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.</p>"""

attributes instance-attribute

attributes: NotRequired[ICD10CMAttributeList]

The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.

begin_offset instance-attribute

begin_offset: NotRequired[Integer]

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

category instance-attribute

category: NotRequired[ICD10CMEntityCategory]

The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.

end_offset instance-attribute

end_offset: NotRequired[Integer]

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

icd10_cm_concepts instance-attribute

icd10_cm_concepts: NotRequired[ICD10CMConceptList]

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

id instance-attribute

id: NotRequired[Integer]

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

score instance-attribute

score: NotRequired[Float]

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

text instance-attribute

The segment of input text that is matched to the detected entity.

traits instance-attribute

traits: NotRequired[ICD10CMTraitList]

Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS, SIGN, SYMPTOM, and NEGATION.

type instance-attribute

type: NotRequired[ICD10CMEntityType]

Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION.