{ "version":"2.0", "metadata":{ "apiVersion":"2018-10-30", "endpointPrefix":"comprehendmedical", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"ComprehendMedical", "serviceFullName":"AWS Comprehend Medical", "serviceId":"ComprehendMedical", "signatureVersion":"v4", "signingName":"comprehendmedical", "targetPrefix":"ComprehendMedical_20181030", "uid":"comprehendmedical-2018-10-30" }, "operations":{ "DescribeEntitiesDetectionV2Job":{ "name":"DescribeEntitiesDetectionV2Job", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEntitiesDetectionV2JobRequest"}, "output":{"shape":"DescribeEntitiesDetectionV2JobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

" }, "DescribeICD10CMInferenceJob":{ "name":"DescribeICD10CMInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeICD10CMInferenceJobRequest"}, "output":{"shape":"DescribeICD10CMInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.

" }, "DescribePHIDetectionJob":{ "name":"DescribePHIDetectionJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePHIDetectionJobRequest"}, "output":{"shape":"DescribePHIDetectionJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

" }, "DescribeRxNormInferenceJob":{ "name":"DescribeRxNormInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRxNormInferenceJobRequest"}, "output":{"shape":"DescribeRxNormInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

" }, "DescribeSNOMEDCTInferenceJob":{ "name":"DescribeSNOMEDCTInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSNOMEDCTInferenceJobRequest"}, "output":{"shape":"DescribeSNOMEDCTInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.

" }, "DetectEntities":{ "name":"DetectEntities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetectEntitiesRequest"}, "output":{"shape":"DetectEntitiesResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidEncodingException"}, {"shape":"TextSizeLimitExceededException"} ], "documentation":"

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.

", "deprecated":true, "deprecatedMessage":"This operation is deprecated, use DetectEntitiesV2 instead." }, "DetectEntitiesV2":{ "name":"DetectEntitiesV2", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetectEntitiesV2Request"}, "output":{"shape":"DetectEntitiesV2Response"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidEncodingException"}, {"shape":"TextSizeLimitExceededException"} ], "documentation":"

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.

" }, "DetectPHI":{ "name":"DetectPHI", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetectPHIRequest"}, "output":{"shape":"DetectPHIResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidEncodingException"}, {"shape":"TextSizeLimitExceededException"} ], "documentation":"

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.

" }, "InferICD10CM":{ "name":"InferICD10CM", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InferICD10CMRequest"}, "output":{"shape":"InferICD10CMResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidEncodingException"}, {"shape":"TextSizeLimitExceededException"} ], "documentation":"

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.

" }, "InferRxNorm":{ "name":"InferRxNorm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InferRxNormRequest"}, "output":{"shape":"InferRxNormResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidEncodingException"}, {"shape":"TextSizeLimitExceededException"} ], "documentation":"

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.

" }, "InferSNOMEDCT":{ "name":"InferSNOMEDCT", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InferSNOMEDCTRequest"}, "output":{"shape":"InferSNOMEDCTResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidEncodingException"}, {"shape":"TextSizeLimitExceededException"} ], "documentation":"

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

" }, "ListEntitiesDetectionV2Jobs":{ "name":"ListEntitiesDetectionV2Jobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEntitiesDetectionV2JobsRequest"}, "output":{"shape":"ListEntitiesDetectionV2JobsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ValidationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of medical entity detection jobs that you have submitted.

" }, "ListICD10CMInferenceJobs":{ "name":"ListICD10CMInferenceJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListICD10CMInferenceJobsRequest"}, "output":{"shape":"ListICD10CMInferenceJobsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ValidationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of InferICD10CM jobs that you have submitted.

" }, "ListPHIDetectionJobs":{ "name":"ListPHIDetectionJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPHIDetectionJobsRequest"}, "output":{"shape":"ListPHIDetectionJobsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ValidationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of protected health information (PHI) detection jobs you have submitted.

" }, "ListRxNormInferenceJobs":{ "name":"ListRxNormInferenceJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRxNormInferenceJobsRequest"}, "output":{"shape":"ListRxNormInferenceJobsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ValidationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of InferRxNorm jobs that you have submitted.

" }, "ListSNOMEDCTInferenceJobs":{ "name":"ListSNOMEDCTInferenceJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSNOMEDCTInferenceJobsRequest"}, "output":{"shape":"ListSNOMEDCTInferenceJobsResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ValidationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalServerException"} ], "documentation":"

Gets a list of InferSNOMEDCT jobs a user has submitted.

" }, "StartEntitiesDetectionV2Job":{ "name":"StartEntitiesDetectionV2Job", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartEntitiesDetectionV2JobRequest"}, "output":{"shape":"StartEntitiesDetectionV2JobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Starts an asynchronous medical entity detection job for a collection of documents. Use the `DescribeEntitiesDetectionV2Job` operation to track the status of a job.

" }, "StartICD10CMInferenceJob":{ "name":"StartICD10CMInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartICD10CMInferenceJobRequest"}, "output":{"shape":"StartICD10CMInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

" }, "StartPHIDetectionJob":{ "name":"StartPHIDetectionJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartPHIDetectionJobRequest"}, "output":{"shape":"StartPHIDetectionJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Starts an asynchronous job to detect protected health information (PHI). Use the `DescribePHIDetectionJob` operation to track the status of a job.

" }, "StartRxNormInferenceJob":{ "name":"StartRxNormInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartRxNormInferenceJobRequest"}, "output":{"shape":"StartRxNormInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

" }, "StartSNOMEDCTInferenceJob":{ "name":"StartSNOMEDCTInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartSNOMEDCTInferenceJobRequest"}, "output":{"shape":"StartSNOMEDCTInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

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.

" }, "StopEntitiesDetectionV2Job":{ "name":"StopEntitiesDetectionV2Job", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopEntitiesDetectionV2JobRequest"}, "output":{"shape":"StopEntitiesDetectionV2JobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Stops a medical entities detection job in progress.

" }, "StopICD10CMInferenceJob":{ "name":"StopICD10CMInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopICD10CMInferenceJobRequest"}, "output":{"shape":"StopICD10CMInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Stops an InferICD10CM inference job in progress.

" }, "StopPHIDetectionJob":{ "name":"StopPHIDetectionJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopPHIDetectionJobRequest"}, "output":{"shape":"StopPHIDetectionJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Stops a protected health information (PHI) detection job in progress.

" }, "StopRxNormInferenceJob":{ "name":"StopRxNormInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopRxNormInferenceJobRequest"}, "output":{"shape":"StopRxNormInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"} ], "documentation":"

Stops an InferRxNorm inference job in progress.

" }, "StopSNOMEDCTInferenceJob":{ "name":"StopSNOMEDCTInferenceJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopSNOMEDCTInferenceJobRequest"}, "output":{"shape":"StopSNOMEDCTInferenceJobResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalServerException"} ], "documentation":"

Stops an InferSNOMEDCT inference job in progress.

" } }, "shapes":{ "AnyLengthString":{"type":"string"}, "Attribute":{ "type":"structure", "members":{ "Type":{ "shape":"EntitySubType", "documentation":"

The type of attribute.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

" }, "RelationshipScore":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

" }, "RelationshipType":{ "shape":"RelationshipType", "documentation":"

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`.

" }, "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Text":{ "shape":"String", "documentation":"

The segment of input text extracted as this attribute.

" }, "Category":{ "shape":"EntityType", "documentation":"

The category of attribute.

" }, "Traits":{ "shape":"TraitList", "documentation":"

Contextual information for this attribute.

" } }, "documentation":"

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.

" }, "AttributeList":{ "type":"list", "member":{"shape":"Attribute"} }, "AttributeName":{ "type":"string", "enum":[ "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE" ] }, "BoundedLengthString":{ "type":"string", "max":20000, "min":1 }, "Characters":{ "type":"structure", "members":{ "OriginalTextCharacters":{ "shape":"Integer", "documentation":"

The number of characters present in the input text document as processed by Amazon Comprehend Medical.

" } }, "documentation":"

The number of characters in the input text to be analyzed.

" }, "ClientRequestTokenString":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9-]+$" }, "ComprehendMedicalAsyncJobFilter":{ "type":"structure", "members":{ "JobName":{ "shape":"JobName", "documentation":"

Filters on the name of the job.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

Filters the list of jobs based on job status. Returns only jobs with the specified status.

" }, "SubmitTimeBefore":{ "shape":"Timestamp", "documentation":"

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.

" }, "SubmitTimeAfter":{ "shape":"Timestamp", "documentation":"

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.

" } }, "documentation":"

Provides information for filtering a list of detection jobs.

" }, "ComprehendMedicalAsyncJobProperties":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier assigned to the detection job.

" }, "JobName":{ "shape":"JobName", "documentation":"

The name that you assigned to the detection job.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

The current status of the detection job. If the status is `FAILED`, the `Message` field shows the reason for the failure.

" }, "Message":{ "shape":"AnyLengthString", "documentation":"

A description of the status of a job.

" }, "SubmitTime":{ "shape":"Timestamp", "documentation":"

The time that the detection job was submitted for processing.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The time that the detection job completed.

" }, "ExpirationTime":{ "shape":"Timestamp", "documentation":"

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":{ "shape":"InputDataConfig", "documentation":"

The input data configuration that you supplied when you created the detection job.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

The output data configuration that you supplied when you created the detection job.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language code of the input documents.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

" }, "ManifestFilePath":{ "shape":"ManifestFilePath", "documentation":"

The path to the file that describes the results of a batch job.

" }, "KMSKey":{ "shape":"KMSKey", "documentation":"

The AWS Key Management Service key, if any, used to encrypt the output files.

" }, "ModelVersion":{ "shape":"ModelVersion", "documentation":"

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.

" } }, "documentation":"

Provides information about a detection job.

" }, "ComprehendMedicalAsyncJobPropertiesList":{ "type":"list", "member":{"shape":"ComprehendMedicalAsyncJobProperties"} }, "DescribeEntitiesDetectionV2JobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. The `StartEntitiesDetectionV2Job` operation returns this identifier in its response.

" } } }, "DescribeEntitiesDetectionV2JobResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobProperties":{ "shape":"ComprehendMedicalAsyncJobProperties", "documentation":"

An object that contains the properties associated with a detection job.

" } } }, "DescribeICD10CMInferenceJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. `The StartICD10CMInferenceJob` operation returns this identifier in its response.

" } } }, "DescribeICD10CMInferenceJobResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobProperties":{ "shape":"ComprehendMedicalAsyncJobProperties", "documentation":"

An object that contains the properties associated with a detection job.

" } } }, "DescribePHIDetectionJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. The `StartPHIDetectionJob` operation returns this identifier in its response.

" } } }, "DescribePHIDetectionJobResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobProperties":{ "shape":"ComprehendMedicalAsyncJobProperties", "documentation":"

An object that contains the properties associated with a detection job.

" } } }, "DescribeRxNormInferenceJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob operation returns this identifier in its response.

" } } }, "DescribeRxNormInferenceJobResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobProperties":{ "shape":"ComprehendMedicalAsyncJobProperties", "documentation":"

An object that contains the properties associated with a detection job.

" } } }, "DescribeSNOMEDCTInferenceJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. The StartSNOMEDCTInferenceJob operation returns this identifier in its response.

" } } }, "DescribeSNOMEDCTInferenceJobResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobProperties":{"shape":"ComprehendMedicalAsyncJobProperties"} } }, "DetectEntitiesRequest":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"BoundedLengthString", "documentation":"

A UTF-8 text string containing the clinical content being examined for entities.

" } } }, "DetectEntitiesResponse":{ "type":"structure", "required":[ "Entities", "ModelVersion" ], "members":{ "Entities":{ "shape":"EntityList", "documentation":"

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.

" }, "UnmappedAttributes":{ "shape":"UnmappedAttributeList", "documentation":"

Attributes extracted from the input text that we were unable to relate to an entity.

" }, "PaginationToken":{ "shape":"String", "documentation":"

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

" }, "ModelVersion":{ "shape":"String", "documentation":"

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.

" } } }, "DetectEntitiesV2Request":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"BoundedLengthString", "documentation":"

A UTF-8 string containing the clinical content being examined for entities.

" } } }, "DetectEntitiesV2Response":{ "type":"structure", "required":[ "Entities", "ModelVersion" ], "members":{ "Entities":{ "shape":"EntityList", "documentation":"

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.

" }, "UnmappedAttributes":{ "shape":"UnmappedAttributeList", "documentation":"

Attributes extracted from the input text that couldn't be related to an entity.

" }, "PaginationToken":{ "shape":"String", "documentation":"

If the result to the `DetectEntitiesV2` operation was truncated, include the `PaginationToken` to fetch the next page of entities.

" }, "ModelVersion":{ "shape":"String", "documentation":"

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.

" } } }, "DetectPHIRequest":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"BoundedLengthString", "documentation":"

A UTF-8 text string containing the clinical content being examined for PHI entities.

" } } }, "DetectPHIResponse":{ "type":"structure", "required":[ "Entities", "ModelVersion" ], "members":{ "Entities":{ "shape":"EntityList", "documentation":"

The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.

" }, "PaginationToken":{ "shape":"String", "documentation":"

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

" }, "ModelVersion":{ "shape":"String", "documentation":"

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.

" } } }, "Entity":{ "type":"structure", "members":{ "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

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.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

" }, "Text":{ "shape":"String", "documentation":"

The segment of input text extracted as this entity.

" }, "Category":{ "shape":"EntityType", "documentation":"

The category of the entity.

" }, "Type":{ "shape":"EntitySubType", "documentation":"

Describes the specific type of entity with category of entities.

" }, "Traits":{ "shape":"TraitList", "documentation":"

Contextual information for the entity.

" }, "Attributes":{ "shape":"AttributeList", "documentation":"

The extracted attributes that relate to this entity.

" } }, "documentation":"

Provides information about an extracted medical entity.

" }, "EntityList":{ "type":"list", "member":{"shape":"Entity"} }, "EntitySubType":{ "type":"string", "enum":[ "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", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE" ] }, "EntityType":{ "type":"string", "enum":[ "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL" ] }, "Float":{"type":"float"}, "ICD10CMAttribute":{ "type":"structure", "members":{ "Type":{ "shape":"ICD10CMAttributeType", "documentation":"

The type of attribute. InferICD10CM detects entities of the type `DX_NAME`.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

" }, "RelationshipScore":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

" }, "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Text":{ "shape":"String", "documentation":"

The segment of input text which contains the detected attribute.

" }, "Traits":{ "shape":"ICD10CMTraitList", "documentation":"

The contextual information for the attribute. The traits recognized by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`.

" }, "Category":{ "shape":"ICD10CMEntityType", "documentation":"

The category of attribute. Can be either of `DX_NAME` or `TIME_EXPRESSION`.

" }, "RelationshipType":{ "shape":"ICD10CMRelationshipType", "documentation":"

The type of relationship between the entity and attribute. Type for the relationship can be either of `OVERLAP` or `SYSTEM_ORGAN_SITE`.

" } }, "documentation":"

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`.

" }, "ICD10CMAttributeList":{ "type":"list", "member":{"shape":"ICD10CMAttribute"} }, "ICD10CMAttributeType":{ "type":"string", "enum":[ "ACUITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "QUALITY", "QUANTITY", "TIME_TO_DX_NAME", "TIME_EXPRESSION" ] }, "ICD10CMConcept":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The long description of the ICD-10-CM code in the ontology.

" }, "Code":{ "shape":"String", "documentation":"

The ICD-10-CM code that identifies the concept found in the knowledge base from the Centers for Disease Control.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to an ICD-10-CM concept.

" } }, "documentation":"

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

" }, "ICD10CMConceptList":{ "type":"list", "member":{"shape":"ICD10CMConcept"} }, "ICD10CMEntity":{ "type":"structure", "members":{ "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "Text":{ "shape":"OntologyLinkingBoundedLengthString", "documentation":"

The segment of input text that is matched to the detected entity.

" }, "Category":{ "shape":"ICD10CMEntityCategory", "documentation":"

The category of the entity. InferICD10CM detects entities in the `MEDICAL_CONDITION` category.

" }, "Type":{ "shape":"ICD10CMEntityType", "documentation":"

Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type `DX_NAME` and `TIME_EXPRESSION`.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

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.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Attributes":{ "shape":"ICD10CMAttributeList", "documentation":"

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.

" }, "Traits":{ "shape":"ICD10CMTraitList", "documentation":"

Provides Contextual information for the entity. The traits recognized by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION.`

" }, "ICD10CMConcepts":{ "shape":"ICD10CMConceptList", "documentation":"

The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.

" } }, "documentation":"

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.

" }, "ICD10CMEntityCategory":{ "type":"string", "enum":["MEDICAL_CONDITION"] }, "ICD10CMEntityList":{ "type":"list", "member":{"shape":"ICD10CMEntity"} }, "ICD10CMEntityType":{ "type":"string", "enum":[ "DX_NAME", "TIME_EXPRESSION" ] }, "ICD10CMRelationshipType":{ "type":"string", "enum":[ "OVERLAP", "SYSTEM_ORGAN_SITE", "QUALITY" ] }, "ICD10CMTrait":{ "type":"structure", "members":{ "Name":{ "shape":"ICD10CMTraitName", "documentation":"

Provides a name or contextual description about the trait.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as a trait.

" } }, "documentation":"

Contextual information for the entity. The traits recognized by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`.

" }, "ICD10CMTraitList":{ "type":"list", "member":{"shape":"ICD10CMTrait"} }, "ICD10CMTraitName":{ "type":"string", "enum":[ "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE" ] }, "IamRoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" }, "InferICD10CMRequest":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"OntologyLinkingBoundedLengthString", "documentation":"

The input text used for analysis.

" } } }, "InferICD10CMResponse":{ "type":"structure", "required":["Entities"], "members":{ "Entities":{ "shape":"ICD10CMEntityList", "documentation":"

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.

" }, "PaginationToken":{ "shape":"String", "documentation":"

If the result of the previous request to `InferICD10CM` was truncated, include the `PaginationToken` to fetch the next page of medical condition entities.

" }, "ModelVersion":{ "shape":"String", "documentation":"

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.

" } } }, "InferRxNormRequest":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"OntologyLinkingBoundedLengthString", "documentation":"

The input text used for analysis.

" } } }, "InferRxNormResponse":{ "type":"structure", "required":["Entities"], "members":{ "Entities":{ "shape":"RxNormEntityList", "documentation":"

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.

" }, "PaginationToken":{ "shape":"String", "documentation":"

If the result of the previous request to `InferRxNorm` was truncated, include the `PaginationToken` to fetch the next page of medication entities.

" }, "ModelVersion":{ "shape":"String", "documentation":"

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.

" } } }, "InferSNOMEDCTRequest":{ "type":"structure", "required":["Text"], "members":{ "Text":{ "shape":"OntologyLinkingBoundedLengthString", "documentation":"

The input text to be analyzed using InferSNOMEDCT.

" } } }, "InferSNOMEDCTResponse":{ "type":"structure", "required":["Entities"], "members":{ "Entities":{ "shape":"SNOMEDCTEntityList", "documentation":"

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 Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

" }, "PaginationToken":{ "shape":"String", "documentation":"

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

" }, "ModelVersion":{ "shape":"String", "documentation":"

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.

" }, "SNOMEDCTDetails":{ "shape":"SNOMEDCTDetails", "documentation":"

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

" }, "Characters":{ "shape":"Characters", "documentation":"

The number of characters in the input request documentation.

" } } }, "InputDataConfig":{ "type":"structure", "required":["S3Bucket"], "members":{ "S3Bucket":{ "shape":"S3Bucket", "documentation":"

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.

" }, "S3Key":{ "shape":"S3Key", "documentation":"

The path to the input data files in the S3 bucket.

" } }, "documentation":"

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.

" }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An internal server error occurred. Retry your request.

", "exception":true, "fault":true }, "InvalidEncodingException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.

", "exception":true }, "InvalidRequestException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

", "exception":true }, "JobId":{ "type":"string", "max":32, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "JobName":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "JobStatus":{ "type":"string", "enum":[ "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED" ] }, "KMSKey":{ "type":"string", "max":2048, "min":1, "pattern":".*" }, "LanguageCode":{ "type":"string", "enum":["en"] }, "ListEntitiesDetectionV2JobsRequest":{ "type":"structure", "members":{ "Filter":{ "shape":"ComprehendMedicalAsyncJobFilter", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

The maximum number of results to return in each page. The default is 100.

" } } }, "ListEntitiesDetectionV2JobsResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobPropertiesList":{ "shape":"ComprehendMedicalAsyncJobPropertiesList", "documentation":"

A list containing the properties of each job returned.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" } } }, "ListICD10CMInferenceJobsRequest":{ "type":"structure", "members":{ "Filter":{ "shape":"ComprehendMedicalAsyncJobFilter", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

The maximum number of results to return in each page. The default is 100.

" } } }, "ListICD10CMInferenceJobsResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobPropertiesList":{ "shape":"ComprehendMedicalAsyncJobPropertiesList", "documentation":"

A list containing the properties of each job that is returned.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" } } }, "ListPHIDetectionJobsRequest":{ "type":"structure", "members":{ "Filter":{ "shape":"ComprehendMedicalAsyncJobFilter", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

The maximum number of results to return in each page. The default is 100.

" } } }, "ListPHIDetectionJobsResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobPropertiesList":{ "shape":"ComprehendMedicalAsyncJobPropertiesList", "documentation":"

A list containing the properties of each job returned.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" } } }, "ListRxNormInferenceJobsRequest":{ "type":"structure", "members":{ "Filter":{ "shape":"ComprehendMedicalAsyncJobFilter", "documentation":"

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.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

Identifies the next page of results to return.

" } } }, "ListRxNormInferenceJobsResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobPropertiesList":{ "shape":"ComprehendMedicalAsyncJobPropertiesList", "documentation":"

The maximum number of results to return in each page. The default is 100.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" } } }, "ListSNOMEDCTInferenceJobsRequest":{ "type":"structure", "members":{ "Filter":{"shape":"ComprehendMedicalAsyncJobFilter"}, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of InferSNOMEDCT results to return.

" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"

The maximum number of results to return in each page. The default is 100.

" } } }, "ListSNOMEDCTInferenceJobsResponse":{ "type":"structure", "members":{ "ComprehendMedicalAsyncJobPropertiesList":{ "shape":"ComprehendMedicalAsyncJobPropertiesList", "documentation":"

A list containing the properties of each job that is returned.

" }, "NextToken":{ "shape":"String", "documentation":"

Identifies the next page of results to return.

" } } }, "ManifestFilePath":{ "type":"string", "max":4096, "min":1 }, "MaxResultsInteger":{ "type":"integer", "max":500, "min":1 }, "ModelVersion":{"type":"string"}, "OntologyLinkingBoundedLengthString":{ "type":"string", "max":10000, "min":1 }, "OutputDataConfig":{ "type":"structure", "required":["S3Bucket"], "members":{ "S3Bucket":{ "shape":"S3Bucket", "documentation":"

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":{ "shape":"S3Key", "documentation":"

The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.

" } }, "documentation":"

The output properties for a detection job.

" }, "RelationshipType":{ "type":"string", "enum":[ "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", "AMOUNT", "USAGE", "QUALITY" ] }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

", "exception":true }, "RxNormAttribute":{ "type":"structure", "members":{ "Type":{ "shape":"RxNormAttributeType", "documentation":"

The type of attribute. The types of attributes recognized by InferRxNorm are `BRAND_NAME` and `GENERIC_NAME`.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

" }, "RelationshipScore":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.

" }, "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Text":{ "shape":"String", "documentation":"

The segment of input text which corresponds to the detected attribute.

" }, "Traits":{ "shape":"RxNormTraitList", "documentation":"

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.

" } }, "documentation":"

The extracted attributes that relate to this entity. The attributes recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`, `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`.

" }, "RxNormAttributeList":{ "type":"list", "member":{"shape":"RxNormAttribute"} }, "RxNormAttributeType":{ "type":"string", "enum":[ "DOSAGE", "DURATION", "FORM", "FREQUENCY", "RATE", "ROUTE_OR_MODE", "STRENGTH" ] }, "RxNormConcept":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the RxNorm concept.

" }, "Code":{ "shape":"String", "documentation":"

RxNorm concept ID, also known as the RxCUI.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to the reported RxNorm concept.

" } }, "documentation":"

The RxNorm concept that the entity could refer to, along with a score indicating the likelihood of the match.

" }, "RxNormConceptList":{ "type":"list", "member":{"shape":"RxNormConcept"} }, "RxNormEntity":{ "type":"structure", "members":{ "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "Text":{ "shape":"OntologyLinkingBoundedLengthString", "documentation":"

The segment of input text extracted from which the entity was detected.

" }, "Category":{ "shape":"RxNormEntityCategory", "documentation":"

The category of the entity. The recognized categories are `GENERIC` or `BRAND_NAME`.

" }, "Type":{ "shape":"RxNormEntityType", "documentation":"

Describes the specific type of entity. For InferRxNorm, the recognized entity type is `MEDICATION`.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

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.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Attributes":{ "shape":"RxNormAttributeList", "documentation":"

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`, `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`, and `STRENGTH`.

" }, "Traits":{ "shape":"RxNormTraitList", "documentation":"

Contextual information for the entity.

" }, "RxNormConcepts":{ "shape":"RxNormConceptList", "documentation":"

The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

" } }, "documentation":"

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.

" }, "RxNormEntityCategory":{ "type":"string", "enum":["MEDICATION"] }, "RxNormEntityList":{ "type":"list", "member":{"shape":"RxNormEntity"} }, "RxNormEntityType":{ "type":"string", "enum":[ "BRAND_NAME", "GENERIC_NAME" ] }, "RxNormTrait":{ "type":"structure", "members":{ "Name":{ "shape":"RxNormTraitName", "documentation":"

Provides a name or contextual description about the trait.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.

" } }, "documentation":"

The contextual information for the entity. InferRxNorm recognizes the trait `NEGATION`, which is any indication that the patient is not taking a medication.

" }, "RxNormTraitList":{ "type":"list", "member":{"shape":"RxNormTrait"} }, "RxNormTraitName":{ "type":"string", "enum":[ "NEGATION", "PAST_HISTORY" ] }, "S3Bucket":{ "type":"string", "max":63, "min":3, "pattern":"^[0-9a-z\\.\\-_]*(?!\\.)$" }, "S3Key":{ "type":"string", "max":1024, "pattern":".*" }, "SNOMEDCTAttribute":{ "type":"structure", "members":{ "Category":{ "shape":"SNOMEDCTEntityCategory", "documentation":"

The category of the detected attribute. Possible categories include MEDICAL_CONDITION, ANATOMY, and TEST_TREATMENT_PROCEDURE.

" }, "Type":{ "shape":"SNOMEDCTAttributeType", "documentation":"

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.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

" }, "RelationshipScore":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

" }, "RelationshipType":{ "shape":"SNOMEDCTRelationshipType", "documentation":"

The type of relationship that exists between the entity and the related attribute.

" }, "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Text":{ "shape":"String", "documentation":"

The segment of input text extracted as this attribute.

" }, "Traits":{ "shape":"SNOMEDCTTraitList", "documentation":"

Contextual information for an attribute. Examples include signs, symptoms, diagnosis, and negation.

" }, "SNOMEDCTConcepts":{ "shape":"SNOMEDCTConceptList", "documentation":"

The SNOMED-CT concepts specific to an attribute, along with a score indicating the likelihood of the match.

" } }, "documentation":"

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.

" }, "SNOMEDCTAttributeList":{ "type":"list", "member":{"shape":"SNOMEDCTAttribute"} }, "SNOMEDCTAttributeType":{ "type":"string", "enum":[ "ACUITY", "QUALITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_VALUE", "TEST_UNIT" ] }, "SNOMEDCTConcept":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the SNOMED-CT concept.

" }, "Code":{ "shape":"String", "documentation":"

The numeric ID for the SNOMED-CT concept.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence Amazon Comprehend Medical has that the entity should be linked to the identified SNOMED-CT concept.

" } }, "documentation":"

The SNOMED-CT concepts that the entity could refer to, along with a score indicating the likelihood of the match.

" }, "SNOMEDCTConceptList":{ "type":"list", "member":{"shape":"SNOMEDCTConcept"} }, "SNOMEDCTDetails":{ "type":"structure", "members":{ "Edition":{ "shape":"String", "documentation":"

The edition of SNOMED-CT used. The edition used for the InferSNOMEDCT editions is the US edition.

" }, "Language":{ "shape":"String", "documentation":"

The language used in the SNOMED-CT ontology. All Amazon Comprehend Medical operations are US English (en).

" }, "VersionDate":{ "shape":"String", "documentation":"

The version date of the SNOMED-CT ontology used.

" } }, "documentation":"

The information about the revision of the SNOMED-CT ontology in the response. Specifically, the details include the SNOMED-CT edition, language, and version date.

" }, "SNOMEDCTEntity":{ "type":"structure", "members":{ "Id":{ "shape":"Integer", "documentation":"

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" }, "Text":{ "shape":"OntologyLinkingBoundedLengthString", "documentation":"

The segment of input text extracted as this entity.

" }, "Category":{ "shape":"SNOMEDCTEntityCategory", "documentation":"

The category of the detected entity. Possible categories are MEDICAL_CONDITION, ANATOMY, or TEST_TREATMENT_PROCEDURE.

" }, "Type":{ "shape":"SNOMEDCTEntityType", "documentation":"

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.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

" }, "BeginOffset":{ "shape":"Integer", "documentation":"

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.

" }, "EndOffset":{ "shape":"Integer", "documentation":"

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.

" }, "Attributes":{ "shape":"SNOMEDCTAttributeList", "documentation":"

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.

" }, "Traits":{ "shape":"SNOMEDCTTraitList", "documentation":"

Contextual information for the entity.

" }, "SNOMEDCTConcepts":{ "shape":"SNOMEDCTConceptList", "documentation":"

The SNOMED concepts that the entity could refer to, along with a score indicating the likelihood of the match.

" } }, "documentation":"

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.

" }, "SNOMEDCTEntityCategory":{ "type":"string", "enum":[ "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE" ] }, "SNOMEDCTEntityList":{ "type":"list", "member":{"shape":"SNOMEDCTEntity"} }, "SNOMEDCTEntityType":{ "type":"string", "enum":[ "DX_NAME", "TEST_NAME", "PROCEDURE_NAME", "TREATMENT_NAME" ] }, "SNOMEDCTRelationshipType":{ "type":"string", "enum":[ "ACUITY", "QUALITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_UNIT" ] }, "SNOMEDCTTrait":{ "type":"structure", "members":{ "Name":{ "shape":"SNOMEDCTTraitName", "documentation":"

The name or contextual description of a detected trait.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of a detected trait.

" } }, "documentation":"

Contextual information for an entity.

" }, "SNOMEDCTTraitList":{ "type":"list", "member":{"shape":"SNOMEDCTTrait"} }, "SNOMEDCTTraitName":{ "type":"string", "enum":[ "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE" ] }, "ServiceUnavailableException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

", "exception":true }, "StartEntitiesDetectionV2JobRequest":{ "type":"structure", "required":[ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members":{ "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

The input configuration that specifies the format and location of the input data for the job.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

The output configuration that specifies where to send the output files.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

" }, "JobName":{ "shape":"JobName", "documentation":"

The identifier of the job.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenString", "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.

", "idempotencyToken":true }, "KMSKey":{ "shape":"KMSKey", "documentation":"

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).

" } } }, "StartEntitiesDetectionV2JobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the `DescribeEntitiesDetectionV2Job` operation.

" } } }, "StartICD10CMInferenceJobRequest":{ "type":"structure", "required":[ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members":{ "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

Specifies the format and location of the input data for the job.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

Specifies where to send the output files.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

" }, "JobName":{ "shape":"JobName", "documentation":"

The identifier of the job.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenString", "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

", "idempotencyToken":true }, "KMSKey":{ "shape":"KMSKey", "documentation":"

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language of the input documents. All documents must be in the same language.

" } } }, "StartICD10CMInferenceJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the `StartICD10CMInferenceJob` operation.

" } } }, "StartPHIDetectionJobRequest":{ "type":"structure", "required":[ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members":{ "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

Specifies the format and location of the input data for the job.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

Specifies where to send the output files.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

" }, "JobName":{ "shape":"JobName", "documentation":"

The identifier of the job.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenString", "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

", "idempotencyToken":true }, "KMSKey":{ "shape":"KMSKey", "documentation":"

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language of the input documents. All documents must be in the same language.

" } } }, "StartPHIDetectionJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the `DescribePHIDetectionJob` operation.

" } } }, "StartRxNormInferenceJobRequest":{ "type":"structure", "required":[ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members":{ "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

Specifies the format and location of the input data for the job.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

Specifies where to send the output files.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

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. For more information, see Role-Based Permissions Required for Asynchronous Operations.

" }, "JobName":{ "shape":"JobName", "documentation":"

The identifier of the job.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenString", "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

", "idempotencyToken":true }, "KMSKey":{ "shape":"KMSKey", "documentation":"

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language of the input documents. All documents must be in the same language.

" } } }, "StartRxNormInferenceJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the job.

" } } }, "StartSNOMEDCTInferenceJobRequest":{ "type":"structure", "required":[ "InputDataConfig", "OutputDataConfig", "DataAccessRoleArn", "LanguageCode" ], "members":{ "InputDataConfig":{"shape":"InputDataConfig"}, "OutputDataConfig":{"shape":"OutputDataConfig"}, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

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.

" }, "JobName":{ "shape":"JobName", "documentation":"

The user generated name the asynchronous InferSNOMEDCT job.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenString", "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

", "idempotencyToken":true }, "KMSKey":{ "shape":"KMSKey", "documentation":"

An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language of the input documents. All documents must be in the same language.

" } } }, "StartSNOMEDCTInferenceJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.

" } } }, "StopEntitiesDetectionV2JobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the medical entities job to stop.

" } } }, "StopEntitiesDetectionV2JobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the medical entities detection job that was stopped.

" } } }, "StopICD10CMInferenceJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the job.

" } } }, "StopICD10CMInferenceJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of job, use this identifier with the `DescribeICD10CMInferenceJob` operation.

" } } }, "StopPHIDetectionJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the PHI detection job to stop.

" } } }, "StopPHIDetectionJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the PHI detection job that was stopped.

" } } }, "StopRxNormInferenceJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier of the job.

" } } }, "StopRxNormInferenceJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of job, use this identifier with the `DescribeRxNormInferenceJob` operation.

" } } }, "StopSNOMEDCTInferenceJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The job id of the asynchronous InferSNOMEDCT job to be stopped.

" } } }, "StopSNOMEDCTInferenceJobResponse":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The identifier generated for the job. To get the status of job, use this identifier with the DescribeSNOMEDCTInferenceJob operation.

" } } }, "String":{ "type":"string", "min":1 }, "TextSizeLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

", "exception":true }, "Timestamp":{"type":"timestamp"}, "TooManyRequestsException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.

", "exception":true }, "Trait":{ "type":"structure", "members":{ "Name":{ "shape":"AttributeName", "documentation":"

Provides a name or contextual description about the trait.

" }, "Score":{ "shape":"Float", "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.

" } }, "documentation":"

Provides contextual information about the extracted entity.

" }, "TraitList":{ "type":"list", "member":{"shape":"Trait"} }, "UnmappedAttribute":{ "type":"structure", "members":{ "Type":{ "shape":"EntityType", "documentation":"

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\".

" }, "Attribute":{ "shape":"Attribute", "documentation":"

The specific attribute that has been extracted but not mapped to an entity.

" } }, "documentation":"

An attribute that was extracted, but Amazon Comprehend Medical was unable to relate to an entity.

" }, "UnmappedAttributeList":{ "type":"list", "member":{"shape":"UnmappedAttribute"} }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.

", "exception":true } }, "documentation":"

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents. Amazon Comprehend Medical only detects entities in English language texts. Amazon Comprehend Medical places limits on the sizes of files allowed for different API operations. To learn more, see Guidelines and quotas in the Amazon Comprehend Medical Developer Guide.

" }