- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ComprehendMedicalClient
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.
Installation
npm install @aws-sdk/client-comprehendmedical
yarn add @aws-sdk/client-comprehendmedical
pnpm add @aws-sdk/client-comprehendmedical
ComprehendMedicalClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
DescribeEntitiesDetectionV2JobCommand | Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job. |
DescribeICD10CMInferenceJobCommand | Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job. |
DescribePHIDetectionJobCommand | Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job. |
DescribeRxNormInferenceJobCommand | Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job. |
DescribeSNOMEDCTInferenceJobCommand | Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job. |
DetectEntitiesCommand | The 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. |
DetectEntitiesV2Command | 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 The |
DetectPHICommand | 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. |
InferICD10CMCommand | 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. |
InferRxNormCommand | 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. |
InferSNOMEDCTCommand | InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology |
ListEntitiesDetectionV2JobsCommand | Gets a list of medical entity detection jobs that you have submitted. |
ListICD10CMInferenceJobsCommand | Gets a list of InferICD10CM jobs that you have submitted. |
ListPHIDetectionJobsCommand | Gets a list of protected health information (PHI) detection jobs you have submitted. |
ListRxNormInferenceJobsCommand | Gets a list of InferRxNorm jobs that you have submitted. |
ListSNOMEDCTInferenceJobsCommand | Gets a list of InferSNOMEDCT jobs a user has submitted. |
StartEntitiesDetectionV2JobCommand | Starts an asynchronous medical entity detection job for a collection of documents. Use the |
StartICD10CMInferenceJobCommand | Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the |
StartPHIDetectionJobCommand | Starts an asynchronous job to detect protected health information (PHI). Use the |
StartRxNormInferenceJobCommand | Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the |
StartSNOMEDCTInferenceJobCommand | 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. |
StopEntitiesDetectionV2JobCommand | Stops a medical entities detection job in progress. |
StopICD10CMInferenceJobCommand | Stops an InferICD10CM inference job in progress. |
StopPHIDetectionJobCommand | Stops a protected health information (PHI) detection job in progress. |
StopRxNormInferenceJobCommand | Stops an InferRxNorm inference job in progress. |
StopSNOMEDCTInferenceJobCommand | Stops an InferSNOMEDCT inference job in progress. |
ComprehendMedicalClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ComprehendMedicalClientConfig