Amazonka.ComprehendMedical.InferRxNorm

InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.

Creating a Request

data InferRxNorm

See: newInferRxNorm smart constructor.

Constructors

InferRxNorm'

Fields

• text :: Text

  The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.

Instances

ToJSON InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

toJSON :: InferRxNorm -> Value

toEncoding :: InferRxNorm -> Encoding

toJSONList :: [InferRxNorm] -> Value

toEncodingList :: [InferRxNorm] -> Encoding

ToHeaders InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

toHeaders :: InferRxNorm -> [Header]

ToPath InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

toPath :: InferRxNorm -> ByteString

ToQuery InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

toQuery :: InferRxNorm -> QueryString

AWSRequest InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Associated Types

type AWSResponse InferRxNorm

Methods

request :: (Service -> Service) -> InferRxNorm -> Request InferRxNorm

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InferRxNorm -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InferRxNorm)))

Generic InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Associated Types

type Rep InferRxNorm :: Type -> Type

Methods

from :: InferRxNorm -> Rep InferRxNorm x

to :: Rep InferRxNorm x -> InferRxNorm

Read InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

readsPrec :: Int -> ReadS InferRxNorm

readList :: ReadS [InferRxNorm]

readPrec :: ReadPrec InferRxNorm

readListPrec :: ReadPrec [InferRxNorm]

Show InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

showsPrec :: Int -> InferRxNorm -> ShowS

show :: InferRxNorm -> String

showList :: [InferRxNorm] -> ShowS

NFData InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

rnf :: InferRxNorm -> ()

Eq InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

(==) :: InferRxNorm -> InferRxNorm -> Bool

(/=) :: InferRxNorm -> InferRxNorm -> Bool

Hashable InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

hashWithSalt :: Int -> InferRxNorm -> Int

hash :: InferRxNorm -> Int

type AWSResponse InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

type AWSResponse InferRxNorm = InferRxNormResponse

type Rep InferRxNorm

Defined in Amazonka.ComprehendMedical.InferRxNorm

type Rep InferRxNorm = D1 ('MetaData "InferRxNorm" "Amazonka.ComprehendMedical.InferRxNorm" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "InferRxNorm'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInferRxNorm

Arguments

:: Text

InferRxNorm

-> InferRxNorm

Create a value of InferRxNorm 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:

InferRxNorm, inferRxNorm_text - The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.

Request Lenses

inferRxNorm_text :: Lens' InferRxNorm Text

The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.

Destructuring the Response

data InferRxNormResponse

See: newInferRxNormResponse smart constructor.

Constructors

InferRxNormResponse'

Fields

• modelVersion :: Maybe Text

  The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

• paginationToken :: Maybe Text

  If the result of the previous request to InferRxNorm was truncated, include the PaginationToken to fetch the next page of medication entities.

• httpStatus :: Int

  The response's http status code.

• entities :: [RxNormEntity]

  The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

Instances

Generic InferRxNormResponse

Defined in Amazonka.ComprehendMedical.InferRxNorm

Associated Types

type Rep InferRxNormResponse :: Type -> Type

Methods

from :: InferRxNormResponse -> Rep InferRxNormResponse x

to :: Rep InferRxNormResponse x -> InferRxNormResponse

Read InferRxNormResponse

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

readsPrec :: Int -> ReadS InferRxNormResponse

readList :: ReadS [InferRxNormResponse]

readPrec :: ReadPrec InferRxNormResponse

readListPrec :: ReadPrec [InferRxNormResponse]

Show InferRxNormResponse

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

showsPrec :: Int -> InferRxNormResponse -> ShowS

show :: InferRxNormResponse -> String

showList :: [InferRxNormResponse] -> ShowS

NFData InferRxNormResponse

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

rnf :: InferRxNormResponse -> ()

Eq InferRxNormResponse

Defined in Amazonka.ComprehendMedical.InferRxNorm

Methods

(==) :: InferRxNormResponse -> InferRxNormResponse -> Bool

(/=) :: InferRxNormResponse -> InferRxNormResponse -> Bool

type Rep InferRxNormResponse

Defined in Amazonka.ComprehendMedical.InferRxNorm

type Rep InferRxNormResponse = D1 ('MetaData "InferRxNormResponse" "Amazonka.ComprehendMedical.InferRxNorm" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "InferRxNormResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "modelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RxNormEntity]))))

newInferRxNormResponse

Arguments

:: Int

$sel:httpStatus:InferRxNormResponse'

-> InferRxNormResponse

Create a value of InferRxNormResponse 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:

InferRxNormResponse, inferRxNormResponse_modelVersion - The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

$sel:paginationToken:InferRxNormResponse', inferRxNormResponse_paginationToken - If the result of the previous request to InferRxNorm was truncated, include the PaginationToken to fetch the next page of medication entities.

$sel:httpStatus:InferRxNormResponse', inferRxNormResponse_httpStatus - The response's http status code.

$sel:entities:InferRxNormResponse', inferRxNormResponse_entities - The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.

Response Lenses

inferRxNormResponse_modelVersion :: Lens' InferRxNormResponse (Maybe Text)

The version of the model used to analyze the documents, in the format n.n.n You can use this information to track the model used for a particular batch of documents.

inferRxNormResponse_paginationToken :: Lens' InferRxNormResponse (Maybe Text)

If the result of the previous request to InferRxNorm was truncated, include the PaginationToken to fetch the next page of medication entities.

inferRxNormResponse_httpStatus :: Lens' InferRxNormResponse Int

The response's http status code.

inferRxNormResponse_entities :: Lens' InferRxNormResponse [RxNormEntity]

The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.