Skip to content

SNOMEDCTEntity

Source code in docs_src/capo_comprehendmedical/types/snomedct_entity.py
class SNOMEDCTEntity(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 extracted as this entity. </p>"""
    category: NotRequired[
        "capo_comprehendmedical.types.snomedct_entity_category.SNOMEDCTEntityCategory"
    ]
    """<p> The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE. </p>"""
    type: NotRequired[
        "capo_comprehendmedical.types.snomedct_entity_type.SNOMEDCTEntityType"
    ]
    """<p> Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME. </p>"""
    score: NotRequired["capo_comprehendmedical.types.float.Float"]
    """<p> The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity. </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.snomedct_attribute_list.SNOMEDCTAttributeList"
    ]
    """<p> 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. </p>"""
    traits: NotRequired[
        "capo_comprehendmedical.types.snomedct_trait_list.SNOMEDCTTraitList"
    ]
    """<p> Contextual information for the entity. </p>"""
    snomedct_concepts: NotRequired[
        "capo_comprehendmedical.types.snomedct_concept_list.SNOMEDCTConceptList"
    ]
    """<p> The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match. </p>"""

attributes instance-attribute

attributes: NotRequired[SNOMEDCTAttributeList]

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.

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[SNOMEDCTEntityCategory]

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

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.

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 detected entity.

snomedct_concepts instance-attribute

snomedct_concepts: NotRequired[SNOMEDCTConceptList]

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

text instance-attribute

The segment of input text extracted as this entity.

traits instance-attribute

traits: NotRequired[SNOMEDCTTraitList]

Contextual information for the entity.

type instance-attribute

type: NotRequired[SNOMEDCTEntityType]

Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.