/AWS1/CL_CPMRXNORMENTITY

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_id TYPE /AWS1/CPMINTEGER /AWS1/CPMINTEGER

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

iv_text TYPE /AWS1/CPMONTOLOGYLINKINGBOUN00 /AWS1/CPMONTOLOGYLINKINGBOUN00

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

iv_category TYPE /AWS1/CPMRXNORMENTITYCATEGORY /AWS1/CPMRXNORMENTITYCATEGORY

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

iv_type TYPE /AWS1/CPMRXNORMENTITYTYPE /AWS1/CPMRXNORMENTITYTYPE

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

iv_score TYPE /AWS1/RT_FLOAT_AS_STRING /AWS1/RT_FLOAT_AS_STRING

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

iv_beginoffset TYPE /AWS1/CPMINTEGER /AWS1/CPMINTEGER

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.

iv_endoffset TYPE /AWS1/CPMINTEGER /AWS1/CPMINTEGER

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.

it_attributes TYPE /AWS1/CL_CPMRXNORMATTRIBUTE=>TT_RXNORMATTRIBUTELIST TT_RXNORMATTRIBUTELIST

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

it_traits TYPE /AWS1/CL_CPMRXNORMTRAIT=>TT_RXNORMTRAITLIST TT_RXNORMTRAITLIST

Contextual information for the entity.

it_rxnormconcepts TYPE /AWS1/CL_CPMRXNORMCONCEPT=>TT_RXNORMCONCEPTLIST TT_RXNORMCONCEPTLIST

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

---

Queryable Attributes

Id

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

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

Text

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

Accessible with the following methods

Method	Description
GET_TEXT()	Getter for TEXT, with configurable default
ASK_TEXT()	Getter for TEXT w/ exceptions if field has no value
HAS_TEXT()	Determine if TEXT has a value

Category

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

Accessible with the following methods

Method	Description
GET_CATEGORY()	Getter for CATEGORY, with configurable default
ASK_CATEGORY()	Getter for CATEGORY w/ exceptions if field has no value
HAS_CATEGORY()	Determine if CATEGORY has a value

Type

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

Accessible with the following methods

Method	Description
GET_TYPE()	Getter for TYPE, with configurable default
ASK_TYPE()	Getter for TYPE w/ exceptions if field has no value
HAS_TYPE()	Determine if TYPE has a value

Score

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

Accessible with the following methods

Method	Description
GET_SCORE()	Getter for SCORE, with configurable default
ASK_SCORE()	Getter for SCORE w/ exceptions if field has no value
STR_SCORE()	String format for SCORE, with configurable default
HAS_SCORE()	Determine if SCORE has a value

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.

Accessible with the following methods

Method	Description
GET_BEGINOFFSET()	Getter for BEGINOFFSET, with configurable default
ASK_BEGINOFFSET()	Getter for BEGINOFFSET w/ exceptions if field has no value
HAS_BEGINOFFSET()	Determine if BEGINOFFSET has a value

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.

Accessible with the following methods

Method	Description
GET_ENDOFFSET()	Getter for ENDOFFSET, with configurable default
ASK_ENDOFFSET()	Getter for ENDOFFSET w/ exceptions if field has no value
HAS_ENDOFFSET()	Determine if ENDOFFSET has a value

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.

Accessible with the following methods

Method	Description
GET_ATTRIBUTES()	Getter for ATTRIBUTES, with configurable default
ASK_ATTRIBUTES()	Getter for ATTRIBUTES w/ exceptions if field has no value
HAS_ATTRIBUTES()	Determine if ATTRIBUTES has a value

Traits

Contextual information for the entity.

Accessible with the following methods

Method	Description
GET_TRAITS()	Getter for TRAITS, with configurable default
ASK_TRAITS()	Getter for TRAITS w/ exceptions if field has no value
HAS_TRAITS()	Determine if TRAITS has a value

RxNormConcepts

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

Accessible with the following methods

Method	Description
GET_RXNORMCONCEPTS()	Getter for RXNORMCONCEPTS, with configurable default
ASK_RXNORMCONCEPTS()	Getter for RXNORMCONCEPTS w/ exceptions if field has no valu
HAS_RXNORMCONCEPTS()	Determine if RXNORMCONCEPTS has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_RXNORMENTITYLIST

TYPES TT_RXNORMENTITYLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_CPMRXNORMENTITY WITH DEFAULT KEY
.