Skip to content

SNOMEDCTAttribute

Source code in docs_src/capo_comprehendmedical/types/snomedct_attribute.py
class SNOMEDCTAttribute(TypedDict, closed=True):
    category: NotRequired[
        "capo_comprehendmedical.types.snomedct_entity_category.SNOMEDCTEntityCategory"
    ]
    """<p> The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE. </p>"""
    type: NotRequired[
        "capo_comprehendmedical.types.snomedct_attribute_type.SNOMEDCTAttributeType"
    ]
    """<p> The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME. </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>"""
    relationship_type: NotRequired[
        "capo_comprehendmedical.types.snomedct_relationship_type.SNOMEDCTRelationshipType"
    ]
    """<p> The type of relationship that exists between the entity and the related attribute. </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 extracted as this attribute. </p>"""
    traits: NotRequired[
        "capo_comprehendmedical.types.snomedct_trait_list.SNOMEDCTTraitList"
    ]
    """<p> Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation. </p>"""
    snomedct_concepts: NotRequired[
        "capo_comprehendmedical.types.snomedct_concept_list.SNOMEDCTConceptList"
    ]
    """<p> The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match. </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[SNOMEDCTEntityCategory]

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

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

The type of relationship that exists between the entity and the related attribute.

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.

snomedct_concepts instance-attribute

snomedct_concepts: NotRequired[SNOMEDCTConceptList]

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

text instance-attribute

text: NotRequired[String]

The segment of input text extracted as this attribute.

traits instance-attribute

traits: NotRequired[SNOMEDCTTraitList]

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

type instance-attribute

type: NotRequired[SNOMEDCTAttributeType]

The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.