Documentation

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

See: newSNOMEDCTEntity smart constructor.

Create a value of SNOMEDCTEntity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributes:SNOMEDCTEntity', sNOMEDCTEntity_attributes - 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.

SNOMEDCTEntity, sNOMEDCTEntity_beginOffset - 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.

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

SNOMEDCTEntity, sNOMEDCTEntity_endOffset - 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.

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

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

SNOMEDCTEntity, sNOMEDCTEntity_score - The level of confidence that Comprehend Medical has in the accuracy of the detected entity.

SNOMEDCTEntity, sNOMEDCTEntity_text - The segment of input text extracted as this entity.

SNOMEDCTEntity, sNOMEDCTEntity_traits - Contextual information for the entity.

SNOMEDCTEntity, sNOMEDCTEntity_type - 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.

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.

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.

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

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.

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

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

The level of confidence that Comprehend Medical has in the accuracy of the detected entity.

The segment of input text extracted as this entity.

Contextual information for the entity.

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.