SNOMEDCTEntity
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.
Contents
- 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.
Type: Array of SNOMEDCTAttribute objects
Required: No
- 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.
Type: Integer
Required: No
- Category
-
The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
Type: String
Valid Values:
MEDICAL_CONDITION | ANATOMY | TEST_TREATMENT_PROCEDURERequired: No
- 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.
Type: Integer
Required: No
- Id
-
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
Type: Integer
Required: No
- Score
-
The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
Type: Float
Required: No
- SNOMEDCTConcepts
-
The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
Type: Array of SNOMEDCTConcept objects
Required: No
- Text
-
The segment of input text extracted as this entity.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: No
- Traits
-
Contextual information for the entity.
Type: Array of SNOMEDCTTrait objects
Required: No
- 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.
Type: String
Valid Values:
DX_NAME | TEST_NAME | PROCEDURE_NAME | TREATMENT_NAMERequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
