Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ComprehendMedical.InferSNOMEDCT

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

Synopsis

data InferSNOMEDCT = InferSNOMEDCT' {
- text :: Text
}
newInferSNOMEDCT :: Text -> InferSNOMEDCT
inferSNOMEDCT_text :: Lens' InferSNOMEDCT Text
data InferSNOMEDCTResponse = InferSNOMEDCTResponse' {
- characters :: Maybe Characters
- modelVersion :: Maybe Text
- paginationToken :: Maybe Text
- sNOMEDCTDetails :: Maybe SNOMEDCTDetails
- httpStatus :: Int
- entities :: [SNOMEDCTEntity]
}
newInferSNOMEDCTResponse :: Int -> InferSNOMEDCTResponse
inferSNOMEDCTResponse_characters :: Lens' InferSNOMEDCTResponse (Maybe Characters)
inferSNOMEDCTResponse_modelVersion :: Lens' InferSNOMEDCTResponse (Maybe Text)
inferSNOMEDCTResponse_paginationToken :: Lens' InferSNOMEDCTResponse (Maybe Text)
inferSNOMEDCTResponse_sNOMEDCTDetails :: Lens' InferSNOMEDCTResponse (Maybe SNOMEDCTDetails)
inferSNOMEDCTResponse_httpStatus :: Lens' InferSNOMEDCTResponse Int
inferSNOMEDCTResponse_entities :: Lens' InferSNOMEDCTResponse [SNOMEDCTEntity]

Creating a Request

data InferSNOMEDCT Source #

See: newInferSNOMEDCT smart constructor.

Constructors

InferSNOMEDCT'
Fields text :: Text The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.

Instances

Instances details

ToJSON InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods toJSON :: InferSNOMEDCT -> Value # toEncoding :: InferSNOMEDCT -> Encoding # toJSONList :: [InferSNOMEDCT] -> Value # toEncodingList :: [InferSNOMEDCT] -> Encoding #
ToHeaders InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods toHeaders :: InferSNOMEDCT -> [Header] #
ToPath InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods toPath :: InferSNOMEDCT -> ByteString #
ToQuery InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods toQuery :: InferSNOMEDCT -> QueryString #
AWSRequest InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Associated Types type AWSResponse InferSNOMEDCT # Methods request :: (Service -> Service) -> InferSNOMEDCT -> Request InferSNOMEDCT # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy InferSNOMEDCT -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InferSNOMEDCT))) #
Generic InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Associated Types type Rep InferSNOMEDCT :: Type -> Type # Methods from :: InferSNOMEDCT -> Rep InferSNOMEDCT x # to :: Rep InferSNOMEDCT x -> InferSNOMEDCT #
Read InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods readsPrec :: Int -> ReadS InferSNOMEDCT # readList :: ReadS [InferSNOMEDCT] # readPrec :: ReadPrec InferSNOMEDCT # readListPrec :: ReadPrec [InferSNOMEDCT] #
Show InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods showsPrec :: Int -> InferSNOMEDCT -> ShowS # show :: InferSNOMEDCT -> String # showList :: [InferSNOMEDCT] -> ShowS #
NFData InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods rnf :: InferSNOMEDCT -> () #
Eq InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods (==) :: InferSNOMEDCT -> InferSNOMEDCT -> Bool # (/=) :: InferSNOMEDCT -> InferSNOMEDCT -> Bool #
Hashable InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods hashWithSalt :: Int -> InferSNOMEDCT -> Int # hash :: InferSNOMEDCT -> Int #
type AWSResponse InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT type AWSResponse InferSNOMEDCT = InferSNOMEDCTResponse
type Rep InferSNOMEDCT Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT type Rep InferSNOMEDCT = D1 ('MetaData "InferSNOMEDCT" "Amazonka.ComprehendMedical.InferSNOMEDCT" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "InferSNOMEDCT'" 'PrefixI 'True) (S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newInferSNOMEDCT Source #

Arguments

:: Text	`InferSNOMEDCT`
-> InferSNOMEDCT

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

InferSNOMEDCT, inferSNOMEDCT_text - The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.

Request Lenses

inferSNOMEDCT_text :: Lens' InferSNOMEDCT Text Source #

The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.

Destructuring the Response

data InferSNOMEDCTResponse Source #

See: newInferSNOMEDCTResponse smart constructor.

Constructors

InferSNOMEDCTResponse'

Fields

characters :: Maybe Characters
The number of characters in the input request documentation.
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 request is truncated, the pagination token can be used to fetch the next page of entities.
sNOMEDCTDetails :: Maybe SNOMEDCTDetails
The details of the SNOMED-CT revision, including the edition, language, and version date.
httpStatus :: Int
The response's http status code.
entities :: [SNOMEDCTEntity]
The collection of medical concept 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.

Instances

Instances details

Generic InferSNOMEDCTResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Associated Types type Rep InferSNOMEDCTResponse :: Type -> Type # Methods from :: InferSNOMEDCTResponse -> Rep InferSNOMEDCTResponse x # to :: Rep InferSNOMEDCTResponse x -> InferSNOMEDCTResponse #
Read InferSNOMEDCTResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods readsPrec :: Int -> ReadS InferSNOMEDCTResponse # readList :: ReadS [InferSNOMEDCTResponse] # readPrec :: ReadPrec InferSNOMEDCTResponse # readListPrec :: ReadPrec [InferSNOMEDCTResponse] #
Show InferSNOMEDCTResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods showsPrec :: Int -> InferSNOMEDCTResponse -> ShowS # show :: InferSNOMEDCTResponse -> String # showList :: [InferSNOMEDCTResponse] -> ShowS #
NFData InferSNOMEDCTResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods rnf :: InferSNOMEDCTResponse -> () #
Eq InferSNOMEDCTResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT Methods (==) :: InferSNOMEDCTResponse -> InferSNOMEDCTResponse -> Bool # (/=) :: InferSNOMEDCTResponse -> InferSNOMEDCTResponse -> Bool #
type Rep InferSNOMEDCTResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.InferSNOMEDCT type Rep InferSNOMEDCTResponse = D1 ('MetaData "InferSNOMEDCTResponse" "Amazonka.ComprehendMedical.InferSNOMEDCT" "amazonka-comprehendmedical-2.0-K5bRdy29Oz63JzqZPPUiej" 'False) (C1 ('MetaCons "InferSNOMEDCTResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "characters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Characters)) :: (S1 ('MetaSel ('Just "modelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "sNOMEDCTDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SNOMEDCTDetails)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "entities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [SNOMEDCTEntity])))))

newInferSNOMEDCTResponse Source #

Arguments

:: Int	`$sel:httpStatus:InferSNOMEDCTResponse'`
-> InferSNOMEDCTResponse

Create a value of InferSNOMEDCTResponse 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:characters:InferSNOMEDCTResponse', inferSNOMEDCTResponse_characters - The number of characters in the input request documentation.

InferSNOMEDCTResponse, inferSNOMEDCTResponse_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:InferSNOMEDCTResponse', inferSNOMEDCTResponse_paginationToken - If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.

$sel:sNOMEDCTDetails:InferSNOMEDCTResponse', inferSNOMEDCTResponse_sNOMEDCTDetails - The details of the SNOMED-CT revision, including the edition, language, and version date.

$sel:httpStatus:InferSNOMEDCTResponse', inferSNOMEDCTResponse_httpStatus - The response's http status code.

$sel:entities:InferSNOMEDCTResponse', inferSNOMEDCTResponse_entities - The collection of medical concept 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.

Response Lenses

inferSNOMEDCTResponse_characters :: Lens' InferSNOMEDCTResponse (Maybe Characters) Source #

The number of characters in the input request documentation.

inferSNOMEDCTResponse_modelVersion :: Lens' InferSNOMEDCTResponse (Maybe Text) Source #

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.

inferSNOMEDCTResponse_paginationToken :: Lens' InferSNOMEDCTResponse (Maybe Text) Source #

If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.

inferSNOMEDCTResponse_sNOMEDCTDetails :: Lens' InferSNOMEDCTResponse (Maybe SNOMEDCTDetails) Source #

The details of the SNOMED-CT revision, including the edition, language, and version date.

inferSNOMEDCTResponse_httpStatus :: Lens' InferSNOMEDCTResponse Int Source #

The response's http status code.

inferSNOMEDCTResponse_entities :: Lens' InferSNOMEDCTResponse [SNOMEDCTEntity] Source #

The collection of medical concept 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.