Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ComprehendMedical.DetectPHI

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

Synopsis

data DetectPHI = DetectPHI' {
- text :: Text
}
newDetectPHI :: Text -> DetectPHI
detectPHI_text :: Lens' DetectPHI Text
data DetectPHIResponse = DetectPHIResponse' {
- paginationToken :: Maybe Text
- httpStatus :: Int
- entities :: [Entity]
- modelVersion :: Text
}
newDetectPHIResponse :: Int -> Text -> DetectPHIResponse
detectPHIResponse_paginationToken :: Lens' DetectPHIResponse (Maybe Text)
detectPHIResponse_httpStatus :: Lens' DetectPHIResponse Int
detectPHIResponse_entities :: Lens' DetectPHIResponse [Entity]
detectPHIResponse_modelVersion :: Lens' DetectPHIResponse Text

Creating a Request

data DetectPHI Source #

See: newDetectPHI smart constructor.

Constructors

DetectPHI'
Fields text :: Text A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

Instances

Instances details

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

newDetectPHI Source #

Arguments

:: Text	`$sel:text:DetectPHI'`
-> DetectPHI

Create a value of DetectPHI 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:text:DetectPHI', detectPHI_text - A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

Request Lenses

detectPHI_text :: Lens' DetectPHI Text Source #

A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

Destructuring the Response

data DetectPHIResponse Source #

See: newDetectPHIResponse smart constructor.

Constructors

DetectPHIResponse'

Fields

paginationToken :: Maybe Text
If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
httpStatus :: Int
The response's http status code.
entities :: [Entity]
The collection of PHI 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 its detection.
modelVersion :: Text
The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Instances

Instances details

Eq DetectPHIResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DetectPHI Methods (==) :: DetectPHIResponse -> DetectPHIResponse -> Bool # (/=) :: DetectPHIResponse -> DetectPHIResponse -> Bool #
Read DetectPHIResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DetectPHI Methods readsPrec :: Int -> ReadS DetectPHIResponse # readList :: ReadS [DetectPHIResponse] # readPrec :: ReadPrec DetectPHIResponse # readListPrec :: ReadPrec [DetectPHIResponse] #
Show DetectPHIResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DetectPHI Methods showsPrec :: Int -> DetectPHIResponse -> ShowS # show :: DetectPHIResponse -> String # showList :: [DetectPHIResponse] -> ShowS #
Generic DetectPHIResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DetectPHI Associated Types type Rep DetectPHIResponse :: Type -> Type # Methods from :: DetectPHIResponse -> Rep DetectPHIResponse x # to :: Rep DetectPHIResponse x -> DetectPHIResponse #
NFData DetectPHIResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DetectPHI Methods rnf :: DetectPHIResponse -> () #
type Rep DetectPHIResponse Source #
Instance details Defined in Amazonka.ComprehendMedical.DetectPHI type Rep DetectPHIResponse = D1 ('MetaData "DetectPHIResponse" "Amazonka.ComprehendMedical.DetectPHI" "libZSservicesZSamazonka-comprehendmedicalZSamazonka-comprehendmedical" 'False) (C1 ('MetaCons "DetectPHIResponse'" 'PrefixI 'True) ((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 [Entity]) :*: S1 ('MetaSel ('Just "modelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDetectPHIResponse Source #

Arguments

:: Int	`$sel:httpStatus:DetectPHIResponse'`
-> Text	`$sel:modelVersion:DetectPHIResponse'`
-> DetectPHIResponse

Create a value of DetectPHIResponse 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:paginationToken:DetectPHIResponse', detectPHIResponse_paginationToken - If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.

$sel:httpStatus:DetectPHIResponse', detectPHIResponse_httpStatus - The response's http status code.

$sel:entities:DetectPHIResponse', detectPHIResponse_entities - The collection of PHI 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 its detection.

$sel:modelVersion:DetectPHIResponse', detectPHIResponse_modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

Response Lenses

detectPHIResponse_paginationToken :: Lens' DetectPHIResponse (Maybe Text) Source #

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

detectPHIResponse_httpStatus :: Lens' DetectPHIResponse Int Source #

The response's http status code.

detectPHIResponse_entities :: Lens' DetectPHIResponse [Entity] Source #

The collection of PHI 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 its detection.

detectPHIResponse_modelVersion :: Lens' DetectPHIResponse Text Source #

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.