AWS Comprehend Medical 2018-10-30
- Client: Aws\ComprehendMedical\ComprehendMedicalClient
- Service ID: comprehendmedical
- Version: 2018-10-30
This page describes the parameters and results for the operations of the AWS Comprehend Medical (2018-10-30), and shows how to use the Aws\ComprehendMedical\ComprehendMedicalClient object to call the described operations. This documentation is specific to the 2018-10-30 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- DetectEntities ( array $params = [] )
Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .
- DetectPHI ( array $params = [] )
Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.
Operations
DetectEntities
$result = $client->detectEntities([/* ... */]); $promise = $client->detectEntitiesAsync([/* ... */]);
Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .
Parameter Syntax
$result = $client->detectEntities([
'Text' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Entities' => [
[
'Attributes' => [
[
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
'Id' => <integer>,
'RelationshipScore' => <float>,
'Score' => <float>,
'Text' => '<string>',
'Traits' => [
[
'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
'Score' => <float>,
],
// ...
],
'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
],
// ...
],
'BeginOffset' => <integer>,
'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
'EndOffset' => <integer>,
'Id' => <integer>,
'Score' => <float>,
'Text' => '<string>',
'Traits' => [
[
'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
'Score' => <float>,
],
// ...
],
'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
],
// ...
],
'PaginationToken' => '<string>',
'UnmappedAttributes' => [
[
'Attribute' => [
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
'Id' => <integer>,
'RelationshipScore' => <float>,
'Score' => <float>,
'Text' => '<string>',
'Traits' => [
[
'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
'Score' => <float>,
],
// ...
],
'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
],
'Type' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
],
// ...
],
]
Result Details
Members
- Entities
-
- Required: Yes
- Type: Array of Entity structures
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 Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
- PaginationToken
-
- Type: string
If the result of the previous request to DetectEntities was truncated, include the Paginationtoken to fetch the next page of entities.
- UnmappedAttributes
-
- Type: Array of UnmappedAttribute structures
Attributes extracted from the input text that we were unable to relate to an entity.
Errors
-
InternalServerException:
An internal server error occurred. Retry your request.
-
ServiceUnavailableException:
The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
-
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
-
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
-
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
-
TextSizeLimitExceededException:
The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
DetectPHI
$result = $client->detectPHI([/* ... */]); $promise = $client->detectPHIAsync([/* ... */]);
Inspects the clinical text for personal health information (PHI) entities and entity category, location, and confidence score on that information.
Parameter Syntax
$result = $client->detectPHI([
'Text' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Entities' => [
[
'Attributes' => [
[
'BeginOffset' => <integer>,
'EndOffset' => <integer>,
'Id' => <integer>,
'RelationshipScore' => <float>,
'Score' => <float>,
'Text' => '<string>',
'Traits' => [
[
'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
'Score' => <float>,
],
// ...
],
'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
],
// ...
],
'BeginOffset' => <integer>,
'Category' => 'MEDICATION|MEDICAL_CONDITION|PROTECTED_HEALTH_INFORMATION|TEST_TREATMENT_PROCEDURE|ANATOMY',
'EndOffset' => <integer>,
'Id' => <integer>,
'Score' => <float>,
'Text' => '<string>',
'Traits' => [
[
'Name' => 'SIGN|SYMPTOM|DIAGNOSIS|NEGATION',
'Score' => <float>,
],
// ...
],
'Type' => 'NAME|DOSAGE|ROUTE_OR_MODE|FORM|FREQUENCY|DURATION|GENERIC_NAME|BRAND_NAME|STRENGTH|RATE|ACUITY|TEST_NAME|TEST_VALUE|TEST_UNITS|PROCEDURE_NAME|TREATMENT_NAME|DATE|AGE|CONTACT_POINT|EMAIL|IDENTIFIER|URL|ADDRESS|PROFESSION|SYSTEM_ORGAN_SITE|DIRECTION|QUALITY|QUANTITY',
],
// ...
],
'PaginationToken' => '<string>',
]
Result Details
Members
- Entities
-
- Required: Yes
- Type: Array of Entity structures
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 Comprehend Medical has in its detection.
- PaginationToken
-
- Type: string
If the result of the previous request to DetectPHI was truncated, include the Paginationtoken to fetch the next page of PHI entities.
Errors
-
InternalServerException:
An internal server error occurred. Retry your request.
-
ServiceUnavailableException:
The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
-
TooManyRequestsException:
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
-
InvalidRequestException:
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
-
InvalidEncodingException:
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
-
TextSizeLimitExceededException:
The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
Shapes
Attribute
Description
An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.
Members
- BeginOffset
-
- Type: int
The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.
- EndOffset
-
- Type: int
The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.
- Id
-
- Type: int
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
- RelationshipScore
-
- Type: float
The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.
- Score
-
- Type: float
The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
- Text
-
- Type: string
The segment of input text extracted as this attribute.
- Traits
-
- Type: Array of Trait structures
Contextual information for this attribute.
- Type
-
- Type: string
The type of attribute.
Entity
Description
Provides information about an extracted medical entity.
Members
- Attributes
-
- Type: Array of Attribute structures
The extracted attributes that relate to this entity.
- BeginOffset
-
- Type: int
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.
- Category
-
- Type: string
The category of the entity.
- EndOffset
-
- Type: int
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.
- Id
-
- Type: int
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
- Score
-
- Type: float
The level of confidence that Comprehend Medical has in the accuracy of the detection.
- Text
-
- Type: string
The segment of input text extracted as this entity.
- Traits
-
- Type: Array of Trait structures
Contextual information for the entity
- Type
-
- Type: string
Describes the specific type of entity with category of entities.
InternalServerException
InvalidEncodingException
Description
The input text was not in valid UTF-8 character encoding. Check your text then retry your request.
Members
InvalidRequestException
Description
The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
Members
ServiceUnavailableException
Description
The Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.
Members
TextSizeLimitExceededException
Description
The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
Members
TooManyRequestsException
Description
You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.
Members
Trait
Description
Provides contextual information about the extracted entity.
Members
UnmappedAttribute
Description
An attribute that we extracted, but were unable to relate to an entity.
Members
- Attribute
-
- Type: Attribute structure
The specific attribute that has been extracted but not mapped to an entity.
- Type
-
- Type: string
The type of the attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PERSONAL_HEALTH_INFORMATION".
