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 Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

See: newRxNormEntity smart constructor.

Create a value of RxNormEntity 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:RxNormEntity', rxNormEntity_attributes - The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

RxNormEntity, rxNormEntity_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.

$sel:category:RxNormEntity', rxNormEntity_category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

RxNormEntity, rxNormEntity_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.

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

$sel:rxNormConcepts:RxNormEntity', rxNormEntity_rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

RxNormEntity, rxNormEntity_score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

RxNormEntity, rxNormEntity_text - The segment of input text extracted from which the entity was detected.

RxNormEntity, rxNormEntity_traits - Contextual information for the entity.

RxNormEntity, rxNormEntity_type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

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 entity. The recognized categories are GENERIC or BRAND_NAME.

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 RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

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

The segment of input text extracted from which the entity was detected.

Contextual information for the entity.

Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.