v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1426136110.8 KB

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.

post/#X-Amz-Target=ComprehendMedical_20181030.DetectPHI

Headers

X-Amz-Target'ComprehendMedical_20181030.DetectPHI' required

Request body

Textstring required

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.

Response

Success

PaginationTokenstring

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

ModelVersionstring required

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.