Table of Contents
ComprehendMedical.Client¶A low-level client representing AWS Comprehend Medical (ComprehendMedical)
Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
import boto3
client = boto3.client('comprehendmedical')
These are the available methods:
can_paginate()close()describe_entities_detection_v2_job()describe_icd10_cm_inference_job()describe_phi_detection_job()describe_rx_norm_inference_job()describe_snomedct_inference_job()detect_entities()detect_entities_v2()detect_phi()get_paginator()get_waiter()infer_icd10_cm()infer_rx_norm()infer_snomedct()list_entities_detection_v2_jobs()list_icd10_cm_inference_jobs()list_phi_detection_jobs()list_rx_norm_inference_jobs()list_snomedct_inference_jobs()start_entities_detection_v2_job()start_icd10_cm_inference_job()start_phi_detection_job()start_rx_norm_inference_job()start_snomedct_inference_job()stop_entities_detection_v2_job()stop_icd10_cm_inference_job()stop_phi_detection_job()stop_rx_norm_inference_job()stop_snomedct_inference_job()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
describe_entities_detection_v2_job(**kwargs)¶Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_entities_detection_v2_job(
JobId='string'
)
[REQUIRED]
The identifier that Comprehend Medical; generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.
{
'ComprehendMedicalAsyncJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
}
}
Response Structure
An object that contains the properties associated with a detection job.
The identifier assigned to the detection job.
The name that you assigned to the detection job.
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the detection job was submitted for processing.
The time that the detection job completed.
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
The input data configuration that you supplied when you created the detection job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
The output data configuration that you supplied when you created the detection job.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
The language code of the input documents.
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
The path to the file that describes the results of a batch job.
The AWS Key Management Service key, if any, used to encrypt the output files.
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.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptiondescribe_icd10_cm_inference_job(**kwargs)¶Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
See also: AWS API Documentation
Request Syntax
response = client.describe_icd10_cm_inference_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend Medical generated for the job. The StartICD10CMInferenceJob operation returns this identifier in its response.
{
'ComprehendMedicalAsyncJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
}
}
Response Structure
An object that contains the properties associated with a detection job.
The identifier assigned to the detection job.
The name that you assigned to the detection job.
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the detection job was submitted for processing.
The time that the detection job completed.
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
The input data configuration that you supplied when you created the detection job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
The output data configuration that you supplied when you created the detection job.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
The language code of the input documents.
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
The path to the file that describes the results of a batch job.
The AWS Key Management Service key, if any, used to encrypt the output files.
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.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptiondescribe_phi_detection_job(**kwargs)¶Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
See also: AWS API Documentation
Request Syntax
response = client.describe_phi_detection_job(
JobId='string'
)
[REQUIRED]
The identifier that Comprehend Medical; generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.
{
'ComprehendMedicalAsyncJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
}
}
Response Structure
An object that contains the properties associated with a detection job.
The identifier assigned to the detection job.
The name that you assigned to the detection job.
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the detection job was submitted for processing.
The time that the detection job completed.
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
The input data configuration that you supplied when you created the detection job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
The output data configuration that you supplied when you created the detection job.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
The language code of the input documents.
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
The path to the file that describes the results of a batch job.
The AWS Key Management Service key, if any, used to encrypt the output files.
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.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptiondescribe_rx_norm_inference_job(**kwargs)¶Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
See also: AWS API Documentation
Request Syntax
response = client.describe_rx_norm_inference_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob operation returns this identifier in its response.
{
'ComprehendMedicalAsyncJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
}
}
Response Structure
An object that contains the properties associated with a detection job.
The identifier assigned to the detection job.
The name that you assigned to the detection job.
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the detection job was submitted for processing.
The time that the detection job completed.
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
The input data configuration that you supplied when you created the detection job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
The output data configuration that you supplied when you created the detection job.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
The language code of the input documents.
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
The path to the file that describes the results of a batch job.
The AWS Key Management Service key, if any, used to encrypt the output files.
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.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptiondescribe_snomedct_inference_job(**kwargs)¶Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
See also: AWS API Documentation
Request Syntax
response = client.describe_snomedct_inference_job(
JobId='string'
)
[REQUIRED]
The identifier that Amazon Comprehend Medical generated for the job. The StartSNOMEDCTInferenceJob operation returns this identifier in its response.
{
'ComprehendMedicalAsyncJobProperties': {
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
}
}
Response Structure
Provides information about a detection job.
The identifier assigned to the detection job.
The name that you assigned to the detection job.
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
A description of the status of a job.
The time that the detection job was submitted for processing.
The time that the detection job completed.
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
The input data configuration that you supplied when you created the detection job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
The output data configuration that you supplied when you created the detection job.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
The language code of the input documents.
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
The path to the file that describes the results of a batch job.
The AWS Key Management Service key, if any, used to encrypt the output files.
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.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptiondetect_entities(**kwargs)¶The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.
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 .
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.detect_entities(
Text='string'
)
[REQUIRED]
A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
{
'Entities': [
{
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Score': ...,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
],
'Attributes': [
{
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Score': ...,
'RelationshipScore': ...,
'RelationshipType': 'EVERY'|'WITH_DOSAGE'|'ADMINISTERED_VIA'|'FOR'|'NEGATIVE'|'OVERLAP'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
]
},
]
},
],
'UnmappedAttributes': [
{
'Type': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Attribute': {
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Score': ...,
'RelationshipScore': ...,
'RelationshipType': 'EVERY'|'WITH_DOSAGE'|'ADMINISTERED_VIA'|'FOR'|'NEGATIVE'|'OVERLAP'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
]
}
},
],
'PaginationToken': 'string',
'ModelVersion': 'string'
}
Response Structure
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.
Provides information about an extracted medical entity.
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The level of confidence that Comprehend Medical; has in the accuracy of the detection.
The segment of input text extracted as this entity.
The category of the entity.
Describes the specific type of entity with category of entities.
Contextual information for the entity.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
The extracted attributes that relate to this entity.
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.
The type of attribute.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as an attribute.
The level of confidence that Comprehend Medical; has that this attribute is correctly related to this entity.
The type of relationship between the entity and attribute. Type for the relationship is OVERLAP , indicating that the entity occurred at the same time as the Date_Expression .
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text extracted as this attribute.
The category of attribute.
Contextual information for this attribute.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
Attributes extracted from the input text that we were unable to relate to an entity.
An attribute that was extracted, but Comprehend Medical; was unable to relate to an entity.
The type of the unmapped attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
The specific attribute that has been extracted but not mapped to an entity.
The type of attribute.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as an attribute.
The level of confidence that Comprehend Medical; has that this attribute is correctly related to this entity.
The type of relationship between the entity and attribute. Type for the relationship is OVERLAP , indicating that the entity occurred at the same time as the Date_Expression .
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text extracted as this attribute.
The category of attribute.
Contextual information for this attribute.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.
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.
Exceptions
ComprehendMedical.Client.exceptions.InternalServerExceptionComprehendMedical.Client.exceptions.ServiceUnavailableExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.InvalidEncodingExceptionComprehendMedical.Client.exceptions.TextSizeLimitExceededExceptiondetect_entities_v2(**kwargs)¶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. Amazon Comprehend Medical only detects medical entities in English language texts.
The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.
The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.
See also: AWS API Documentation
Request Syntax
response = client.detect_entities_v2(
Text='string'
)
[REQUIRED]
A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.
{
'Entities': [
{
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Score': ...,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
],
'Attributes': [
{
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Score': ...,
'RelationshipScore': ...,
'RelationshipType': 'EVERY'|'WITH_DOSAGE'|'ADMINISTERED_VIA'|'FOR'|'NEGATIVE'|'OVERLAP'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
]
},
]
},
],
'UnmappedAttributes': [
{
'Type': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Attribute': {
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Score': ...,
'RelationshipScore': ...,
'RelationshipType': 'EVERY'|'WITH_DOSAGE'|'ADMINISTERED_VIA'|'FOR'|'NEGATIVE'|'OVERLAP'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
]
}
},
],
'PaginationToken': 'string',
'ModelVersion': 'string'
}
Response Structure
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 in the detection and analysis. Attributes and traits of the entity are also returned.
Provides information about an extracted medical entity.
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The level of confidence that Comprehend Medical; has in the accuracy of the detection.
The segment of input text extracted as this entity.
The category of the entity.
Describes the specific type of entity with category of entities.
Contextual information for the entity.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
The extracted attributes that relate to this entity.
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.
The type of attribute.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as an attribute.
The level of confidence that Comprehend Medical; has that this attribute is correctly related to this entity.
The type of relationship between the entity and attribute. Type for the relationship is OVERLAP , indicating that the entity occurred at the same time as the Date_Expression .
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text extracted as this attribute.
The category of attribute.
Contextual information for this attribute.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
Attributes extracted from the input text that couldn't be related to an entity.
An attribute that was extracted, but Comprehend Medical; was unable to relate to an entity.
The type of the unmapped attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY", "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
The specific attribute that has been extracted but not mapped to an entity.
The type of attribute.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as an attribute.
The level of confidence that Comprehend Medical; has that this attribute is correctly related to this entity.
The type of relationship between the entity and attribute. Type for the relationship is OVERLAP , indicating that the entity occurred at the same time as the Date_Expression .
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text extracted as this attribute.
The category of attribute.
Contextual information for this attribute.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.
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.
Exceptions
ComprehendMedical.Client.exceptions.InternalServerExceptionComprehendMedical.Client.exceptions.ServiceUnavailableExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.InvalidEncodingExceptionComprehendMedical.Client.exceptions.TextSizeLimitExceededExceptiondetect_phi(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.detect_phi(
Text='string'
)
[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.
{
'Entities': [
{
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Score': ...,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
],
'Attributes': [
{
'Type': 'NAME'|'DX_NAME'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'GENERIC_NAME'|'BRAND_NAME'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_NAME'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'PROCEDURE_NAME'|'TREATMENT_NAME'|'DATE'|'AGE'|'CONTACT_POINT'|'PHONE_OR_FAX'|'EMAIL'|'IDENTIFIER'|'ID'|'URL'|'ADDRESS'|'PROFESSION'|'SYSTEM_ORGAN_SITE'|'DIRECTION'|'QUALITY'|'QUANTITY'|'TIME_EXPRESSION'|'TIME_TO_MEDICATION_NAME'|'TIME_TO_DX_NAME'|'TIME_TO_TEST_NAME'|'TIME_TO_PROCEDURE_NAME'|'TIME_TO_TREATMENT_NAME',
'Score': ...,
'RelationshipScore': ...,
'RelationshipType': 'EVERY'|'WITH_DOSAGE'|'ADMINISTERED_VIA'|'FOR'|'NEGATIVE'|'OVERLAP'|'DOSAGE'|'ROUTE_OR_MODE'|'FORM'|'FREQUENCY'|'DURATION'|'STRENGTH'|'RATE'|'ACUITY'|'TEST_VALUE'|'TEST_UNITS'|'TEST_UNIT'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Category': 'MEDICATION'|'MEDICAL_CONDITION'|'PROTECTED_HEALTH_INFORMATION'|'TEST_TREATMENT_PROCEDURE'|'ANATOMY'|'TIME_EXPRESSION',
'Traits': [
{
'Name': 'SIGN'|'SYMPTOM'|'DIAGNOSIS'|'NEGATION',
'Score': ...
},
]
},
]
},
],
'PaginationToken': 'string',
'ModelVersion': 'string'
}
Response Structure
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.
Provides information about an extracted medical entity.
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The level of confidence that Comprehend Medical; has in the accuracy of the detection.
The segment of input text extracted as this entity.
The category of the entity.
Describes the specific type of entity with category of entities.
Contextual information for the entity.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
The extracted attributes that relate to this entity.
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.
The type of attribute.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as an attribute.
The level of confidence that Comprehend Medical; has that this attribute is correctly related to this entity.
The type of relationship between the entity and attribute. Type for the relationship is OVERLAP , indicating that the entity occurred at the same time as the Date_Expression .
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text extracted as this attribute.
The category of attribute.
Contextual information for this attribute.
Provides contextual information about the extracted entity.
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has in the accuracy of this trait.
If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.
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.
Exceptions
ComprehendMedical.Client.exceptions.InternalServerExceptionComprehendMedical.Client.exceptions.ServiceUnavailableExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.InvalidEncodingExceptionComprehendMedical.Client.exceptions.TextSizeLimitExceededExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
infer_icd10_cm(**kwargs)¶InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.
See also: AWS API Documentation
Request Syntax
response = client.infer_icd10_cm(
Text='string'
)
[REQUIRED]
The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.
{
'Entities': [
{
'Id': 123,
'Text': 'string',
'Category': 'MEDICAL_CONDITION',
'Type': 'DX_NAME'|'TIME_EXPRESSION',
'Score': ...,
'BeginOffset': 123,
'EndOffset': 123,
'Attributes': [
{
'Type': 'ACUITY'|'DIRECTION'|'SYSTEM_ORGAN_SITE'|'QUALITY'|'QUANTITY'|'TIME_TO_DX_NAME'|'TIME_EXPRESSION',
'Score': ...,
'RelationshipScore': ...,
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Traits': [
{
'Name': 'NEGATION'|'DIAGNOSIS'|'SIGN'|'SYMPTOM',
'Score': ...
},
],
'Category': 'DX_NAME'|'TIME_EXPRESSION',
'RelationshipType': 'OVERLAP'|'SYSTEM_ORGAN_SITE'
},
],
'Traits': [
{
'Name': 'NEGATION'|'DIAGNOSIS'|'SIGN'|'SYMPTOM',
'Score': ...
},
],
'ICD10CMConcepts': [
{
'Description': 'string',
'Code': 'string',
'Score': ...
},
]
},
],
'PaginationToken': 'string',
'ModelVersion': 'string'
}
Response Structure
The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is successful, the service sends back an HTTP 200 response, as well as the entities detected.
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 Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
The segment of input text that is matched to the detected entity.
The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type DX_NAME and TIME_EXPRESSION .
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
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.
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.
The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the nature of a medical condition.
The detected attributes that relate to an entity. This includes an extracted segment of the text that is an attribute of an entity, or otherwise related to an entity. InferICD10CM detects the following attributes: Direction , System, Organ or Site , and Acuity .
The type of attribute. InferICD10CM detects entities of the type DX_NAME .
The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text which contains the detected attribute.
The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION .
Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION .
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as a trait.
The category of attribute. Can be either of DX_NAME or TIME_EXPRESSION .
The type of relationship between the entity and attribute. Type for the relationship can be either of OVERLAP or SYSTEM_ORGAN_SITE .
Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION.
Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS , SIGN , SYMPTOM , and NEGATION .
Provides a name or contextual description about the trait.
The level of confidence that Comprehend Medical; has that the segment of text is correctly recognized as a trait.
The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
The long description of the ICD-10-CM code in the ontology.
The ICD-10-CM code that identifies the concept found in the knowledge base from the Centers for Disease Control.
The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to an ICD-10-CM concept.
If the result of the previous request to InferICD10CM was truncated, include the PaginationToken to fetch the next page of medical condition entities.
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.
Exceptions
ComprehendMedical.Client.exceptions.InternalServerExceptionComprehendMedical.Client.exceptions.ServiceUnavailableExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.InvalidEncodingExceptionComprehendMedical.Client.exceptions.TextSizeLimitExceededExceptioninfer_rx_norm(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.infer_rx_norm(
Text='string'
)
[REQUIRED]
The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.
{
'Entities': [
{
'Id': 123,
'Text': 'string',
'Category': 'MEDICATION',
'Type': 'BRAND_NAME'|'GENERIC_NAME',
'Score': ...,
'BeginOffset': 123,
'EndOffset': 123,
'Attributes': [
{
'Type': 'DOSAGE'|'DURATION'|'FORM'|'FREQUENCY'|'RATE'|'ROUTE_OR_MODE'|'STRENGTH',
'Score': ...,
'RelationshipScore': ...,
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Traits': [
{
'Name': 'NEGATION',
'Score': ...
},
]
},
],
'Traits': [
{
'Name': 'NEGATION',
'Score': ...
},
],
'RxNormConcepts': [
{
'Description': 'string',
'Code': 'string',
'Score': ...
},
]
},
],
'PaginationToken': 'string',
'ModelVersion': 'string'
}
Response Structure
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.
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 Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
The segment of input text extracted from which the entity was detected.
The category of the entity. The recognized categories are GENERIC or BRAND_NAME .
Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION .
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
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.
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.
The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE , DURATION , FORM , FREQUENCY , RATE , ROUTE_OR_MODE , and STRENGTH .
The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are DOSAGE , DURATION , FORM , FREQUENCY , RATE , ROUTE_OR_MODE .
The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and GENERIC_NAME .
The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text which corresponds to the detected attribute.
Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes, i.e. that the patient is not taking a specific dose or form of a medication.
The contextual information for the entity. InferRxNorm recognizes the trait NEGATION , which is any indication that the patient is not taking a medication.
Provides a name or contextual description about the trait.
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.
Contextual information for the entity.
The contextual information for the entity. InferRxNorm recognizes the trait NEGATION , which is any indication that the patient is not taking a medication.
Provides a name or contextual description about the trait.
The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.
The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.
The description of the RxNorm concept.
RxNorm concept ID, also known as the RxCUI.
The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to the reported RxNorm concept.
If the result of the previous request to InferRxNorm was truncated, include the PaginationToken to fetch the next page of medication entities.
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.
Exceptions
ComprehendMedical.Client.exceptions.InternalServerExceptionComprehendMedical.Client.exceptions.ServiceUnavailableExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.InvalidEncodingExceptionComprehendMedical.Client.exceptions.TextSizeLimitExceededExceptioninfer_snomedct(**kwargs)¶InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology
See also: AWS API Documentation
Request Syntax
response = client.infer_snomedct(
Text='string'
)
[REQUIRED]
The input text to be analyzed using InferSNOMEDCT. The text should be a string with 1 to 10000 characters.
{
'Entities': [
{
'Id': 123,
'Text': 'string',
'Category': 'MEDICAL_CONDITION'|'ANATOMY'|'TEST_TREATMENT_PROCEDURE',
'Type': 'DX_NAME'|'TEST_NAME'|'PROCEDURE_NAME'|'TREATMENT_NAME',
'Score': ...,
'BeginOffset': 123,
'EndOffset': 123,
'Attributes': [
{
'Category': 'MEDICAL_CONDITION'|'ANATOMY'|'TEST_TREATMENT_PROCEDURE',
'Type': 'ACUITY'|'QUALITY'|'DIRECTION'|'SYSTEM_ORGAN_SITE'|'TEST_VALUE'|'TEST_UNIT',
'Score': ...,
'RelationshipScore': ...,
'RelationshipType': 'ACUITY'|'QUALITY'|'TEST_VALUE'|'TEST_UNITS'|'DIRECTION'|'SYSTEM_ORGAN_SITE',
'Id': 123,
'BeginOffset': 123,
'EndOffset': 123,
'Text': 'string',
'Traits': [
{
'Name': 'NEGATION'|'DIAGNOSIS'|'SIGN'|'SYMPTOM',
'Score': ...
},
],
'SNOMEDCTConcepts': [
{
'Description': 'string',
'Code': 'string',
'Score': ...
},
]
},
],
'Traits': [
{
'Name': 'NEGATION'|'DIAGNOSIS'|'SIGN'|'SYMPTOM',
'Score': ...
},
],
'SNOMEDCTConcepts': [
{
'Description': 'string',
'Code': 'string',
'Score': ...
},
]
},
],
'PaginationToken': 'string',
'ModelVersion': 'string',
'SNOMEDCTDetails': {
'Edition': 'string',
'Language': 'string',
'VersionDate': 'string'
},
'Characters': {
'OriginalTextCharacters': 123
}
}
Response Structure
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.
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.
The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.
The segment of input text extracted as this entity.
The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.
Describes the specific type of entity with category of entities. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE, TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, or TREATMENT_NAME.
The level of confidence that Comprehend Medical has in the accuracy of the detected entity.
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.
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.
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.
The extracted attributes that relate to an entity. 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.
The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.
The type of attribute. Possible types include DX_NAME, ACUITY, DIRECTION, SYSTEM_ORGAN_SITE,TEST_NAME, TEST_VALUE, TEST_UNIT, PROCEDURE_NAME, and TREATMENT_NAME.
The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an attribute.
The level of confidence that Comprehend Medical has that this attribute is correctly related to this entity.
The type of relationship that exists between the entity and the related attribute.
The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.
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.
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.
The segment of input text extracted as this attribute.
Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.
Contextual information for an entity.
The name or contextual description of a detected trait.
The level of confidence that Comprehend Medical has in the accuracy of a detected trait.
The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.
The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.
The description of the SNOMED-CT concept.
The numeric ID for the SNOMED-CT concept.
The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
Contextual information for the entity.
Contextual information for an entity.
The name or contextual description of a detected trait.
The level of confidence that Comprehend Medical has in the accuracy of a detected trait.
The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.
The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.
The description of the SNOMED-CT concept.
The numeric ID for the SNOMED-CT concept.
The level of confidence Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.
If the result of the request is truncated, the pagination token can be used to fetch the next page of entities.
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.
The details of the SNOMED-CT revision, including the edition, language, and version date.
The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions is the US edition.
The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical operations are US English (en).
The version date of the SNOMED-CT ontology used.
The number of characters in the input request documentation.
The number of characters present in the input text document as processed by Comprehend Medical.
Exceptions
ComprehendMedical.Client.exceptions.InternalServerExceptionComprehendMedical.Client.exceptions.ServiceUnavailableExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.InvalidEncodingExceptionComprehendMedical.Client.exceptions.TextSizeLimitExceededExceptionlist_entities_detection_v2_jobs(**kwargs)¶Gets a list of medical entity detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_entities_detection_v2_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
dict
Response Syntax
{
'ComprehendMedicalAsyncJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComprehendMedicalAsyncJobPropertiesList (list) --
A list containing the properties of each job returned.
(dict) --
Provides information about a detection job.
JobId (string) --
The identifier assigned to the detection job.
JobName (string) --
The name that you assigned to the detection job.
JobStatus (string) --
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the detection job was submitted for processing.
EndTime (datetime) --
The time that the detection job completed.
ExpirationTime (datetime) --
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the detection job.
S3Bucket (string) --
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
S3Key (string) --
The path to the input data files in the S3 bucket.
OutputDataConfig (dict) --
The output data configuration that you supplied when you created the detection job.
S3Bucket (string) --
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
S3Key (string) --
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
ManifestFilePath (string) --
The path to the file that describes the results of a batch job.
KMSKey (string) --
The AWS Key Management Service key, if any, used to encrypt the output files.
ModelVersion (string) --
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.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ValidationExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InternalServerExceptionlist_icd10_cm_inference_jobs(**kwargs)¶Gets a list of InferICD10CM jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_icd10_cm_inference_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
dict
Response Syntax
{
'ComprehendMedicalAsyncJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComprehendMedicalAsyncJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a detection job.
JobId (string) --
The identifier assigned to the detection job.
JobName (string) --
The name that you assigned to the detection job.
JobStatus (string) --
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the detection job was submitted for processing.
EndTime (datetime) --
The time that the detection job completed.
ExpirationTime (datetime) --
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the detection job.
S3Bucket (string) --
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
S3Key (string) --
The path to the input data files in the S3 bucket.
OutputDataConfig (dict) --
The output data configuration that you supplied when you created the detection job.
S3Bucket (string) --
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
S3Key (string) --
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
ManifestFilePath (string) --
The path to the file that describes the results of a batch job.
KMSKey (string) --
The AWS Key Management Service key, if any, used to encrypt the output files.
ModelVersion (string) --
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.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ValidationExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InternalServerExceptionlist_phi_detection_jobs(**kwargs)¶Gets a list of protected health information (PHI) detection jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_phi_detection_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
dict
Response Syntax
{
'ComprehendMedicalAsyncJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComprehendMedicalAsyncJobPropertiesList (list) --
A list containing the properties of each job returned.
(dict) --
Provides information about a detection job.
JobId (string) --
The identifier assigned to the detection job.
JobName (string) --
The name that you assigned to the detection job.
JobStatus (string) --
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the detection job was submitted for processing.
EndTime (datetime) --
The time that the detection job completed.
ExpirationTime (datetime) --
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the detection job.
S3Bucket (string) --
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
S3Key (string) --
The path to the input data files in the S3 bucket.
OutputDataConfig (dict) --
The output data configuration that you supplied when you created the detection job.
S3Bucket (string) --
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
S3Key (string) --
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
ManifestFilePath (string) --
The path to the file that describes the results of a batch job.
KMSKey (string) --
The AWS Key Management Service key, if any, used to encrypt the output files.
ModelVersion (string) --
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.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ValidationExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InternalServerExceptionlist_rx_norm_inference_jobs(**kwargs)¶Gets a list of InferRxNorm jobs that you have submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_rx_norm_inference_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
dict
Response Syntax
{
'ComprehendMedicalAsyncJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComprehendMedicalAsyncJobPropertiesList (list) --
The maximum number of results to return in each page. The default is 100.
(dict) --
Provides information about a detection job.
JobId (string) --
The identifier assigned to the detection job.
JobName (string) --
The name that you assigned to the detection job.
JobStatus (string) --
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the detection job was submitted for processing.
EndTime (datetime) --
The time that the detection job completed.
ExpirationTime (datetime) --
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the detection job.
S3Bucket (string) --
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
S3Key (string) --
The path to the input data files in the S3 bucket.
OutputDataConfig (dict) --
The output data configuration that you supplied when you created the detection job.
S3Bucket (string) --
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
S3Key (string) --
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
ManifestFilePath (string) --
The path to the file that describes the results of a batch job.
KMSKey (string) --
The AWS Key Management Service key, if any, used to encrypt the output files.
ModelVersion (string) --
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.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ValidationExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InternalServerExceptionlist_snomedct_inference_jobs(**kwargs)¶Gets a list of InferSNOMEDCT jobs a user has submitted.
See also: AWS API Documentation
Request Syntax
response = client.list_snomedct_inference_jobs(
Filter={
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'SubmitTimeBefore': datetime(2015, 1, 1),
'SubmitTimeAfter': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
Provides information for filtering a list of detection jobs.
Filters on the name of the job.
Filters the list of jobs based on job status. Returns only jobs with the specified status.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.
dict
Response Syntax
{
'ComprehendMedicalAsyncJobPropertiesList': [
{
'JobId': 'string',
'JobName': 'string',
'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'PARTIAL_SUCCESS'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
'Message': 'string',
'SubmitTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'ExpirationTime': datetime(2015, 1, 1),
'InputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'OutputDataConfig': {
'S3Bucket': 'string',
'S3Key': 'string'
},
'LanguageCode': 'en',
'DataAccessRoleArn': 'string',
'ManifestFilePath': 'string',
'KMSKey': 'string',
'ModelVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComprehendMedicalAsyncJobPropertiesList (list) --
A list containing the properties of each job that is returned.
(dict) --
Provides information about a detection job.
JobId (string) --
The identifier assigned to the detection job.
JobName (string) --
The name that you assigned to the detection job.
JobStatus (string) --
The current status of the detection job. If the status is FAILED , the Message field shows the reason for the failure.
Message (string) --
A description of the status of a job.
SubmitTime (datetime) --
The time that the detection job was submitted for processing.
EndTime (datetime) --
The time that the detection job completed.
ExpirationTime (datetime) --
The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
InputDataConfig (dict) --
The input data configuration that you supplied when you created the detection job.
S3Bucket (string) --
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
S3Key (string) --
The path to the input data files in the S3 bucket.
OutputDataConfig (dict) --
The output data configuration that you supplied when you created the detection job.
S3Bucket (string) --
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
S3Key (string) --
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
LanguageCode (string) --
The language code of the input documents.
DataAccessRoleArn (string) --
The Amazon Resource Name (ARN) that gives Comprehend Medical; read access to your input data.
ManifestFilePath (string) --
The path to the file that describes the results of a batch job.
KMSKey (string) --
The AWS Key Management Service key, if any, used to encrypt the output files.
ModelVersion (string) --
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.
NextToken (string) --
Identifies the next page of results to return.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ValidationExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstart_entities_detection_v2_job(**kwargs)¶Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_entities_detection_v2_job(
InputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
OutputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
DataAccessRoleArn='string',
JobName='string',
ClientRequestToken='string',
KMSKey='string',
LanguageCode='en'
)
[REQUIRED]
The input configuration that specifies the format and location of the input data for the job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
[REQUIRED]
The output configuration that specifies where to send the output files.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations .
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one for you.
This field is autopopulated if not provided.
[REQUIRED]
The language of the input documents. All documents must be in the same language. Comprehend Medical; processes files in US English (en).
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the DescribeEntitiesDetectionV2Job operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstart_icd10_cm_inference_job(**kwargs)¶Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_icd10_cm_inference_job(
InputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
OutputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
DataAccessRoleArn='string',
JobName='string',
ClientRequestToken='string',
KMSKey='string',
LanguageCode='en'
)
[REQUIRED]
Specifies the format and location of the input data for the job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
[REQUIRED]
Specifies where to send the output files.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations .
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
This field is autopopulated if not provided.
[REQUIRED]
The language of the input documents. All documents must be in the same language.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the StartICD10CMInferenceJob operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstart_phi_detection_job(**kwargs)¶Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_phi_detection_job(
InputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
OutputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
DataAccessRoleArn='string',
JobName='string',
ClientRequestToken='string',
KMSKey='string',
LanguageCode='en'
)
[REQUIRED]
Specifies the format and location of the input data for the job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
[REQUIRED]
Specifies where to send the output files.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations .
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
This field is autopopulated if not provided.
[REQUIRED]
The language of the input documents. All documents must be in the same language.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the DescribePHIDetectionJob operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstart_rx_norm_inference_job(**kwargs)¶Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_rx_norm_inference_job(
InputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
OutputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
DataAccessRoleArn='string',
JobName='string',
ClientRequestToken='string',
KMSKey='string',
LanguageCode='en'
)
[REQUIRED]
Specifies the format and location of the input data for the job.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
[REQUIRED]
Specifies where to send the output files.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Comprehend Medical; read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations .
A unique identifier for the request. If you don't set the client request token, Comprehend Medical; generates one.
This field is autopopulated if not provided.
[REQUIRED]
The language of the input documents. All documents must be in the same language.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier of the job.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstart_snomedct_inference_job(**kwargs)¶Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.
See also: AWS API Documentation
Request Syntax
response = client.start_snomedct_inference_job(
InputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
OutputDataConfig={
'S3Bucket': 'string',
'S3Key': 'string'
},
DataAccessRoleArn='string',
JobName='string',
ClientRequestToken='string',
KMSKey='string',
LanguageCode='en'
)
[REQUIRED]
The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.
The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.
Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
The path to the input data files in the S3 bucket.
[REQUIRED]
The output properties for a detection job.
When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.
The path to the output data files in the S3 bucket. Comprehend Medical; creates an output directory using the job ID so that the output from one job does not overwrite the output of another.
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.
This field is autopopulated if not provided.
[REQUIRED]
The language of the input documents. All documents must be in the same language.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstop_entities_detection_v2_job(**kwargs)¶Stops a medical entities detection job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_entities_detection_v2_job(
JobId='string'
)
[REQUIRED]
The identifier of the medical entities job to stop.
{
'JobId': 'string'
}
Response Structure
The identifier of the medical entities detection job that was stopped.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstop_icd10_cm_inference_job(**kwargs)¶Stops an InferICD10CM inference job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_icd10_cm_inference_job(
JobId='string'
)
[REQUIRED]
The identifier of the job.
{
'JobId': 'string'
}
Response Structure
The identifier generated for the job. To get the status of job, use this identifier with the DescribeICD10CMInferenceJob operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstop_phi_detection_job(**kwargs)¶Stops a protected health information (PHI) detection job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_phi_detection_job(
JobId='string'
)
[REQUIRED]
The identifier of the PHI detection job to stop.
{
'JobId': 'string'
}
Response Structure
The identifier of the PHI detection job that was stopped.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstop_rx_norm_inference_job(**kwargs)¶Stops an InferRxNorm inference job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_rx_norm_inference_job(
JobId='string'
)
[REQUIRED]
The identifier of the job.
{
'JobId': 'string'
}
Response Structure
The identifier generated for the job. To get the status of job, use this identifier with the DescribeRxNormInferenceJob operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.InternalServerExceptionstop_snomedct_inference_job(**kwargs)¶Stops an InferSNOMEDCT inference job in progress.
See also: AWS API Documentation
Request Syntax
response = client.stop_snomedct_inference_job(
JobId='string'
)
[REQUIRED]
The job id of the asynchronous InferSNOMEDCT job to be stopped.
{
'JobId': 'string'
}
Response Structure
The identifier generated for the job. To get the status of job, use this identifier with the DescribeSNOMEDCTInferenceJob operation.
Exceptions
ComprehendMedical.Client.exceptions.InvalidRequestExceptionComprehendMedical.Client.exceptions.ResourceNotFoundExceptionComprehendMedical.Client.exceptions.TooManyRequestsExceptionComprehendMedical.Client.exceptions.InternalServerExceptionThe available paginators are: