Skip to content

AWS Comprehend Medical API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

Comprehend Medical; extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

AWS Comprehend Medical is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 26 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2018-10-30
Endpoints
26
Spec updated
2020-05-06

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=ComprehendMedical_20181030.DescribeEntitiesDetectionV2JobGets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=ComprehendMedical_20181030.DescribeICD10CMInferenceJobGets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.
POST/#X-Amz-Target=ComprehendMedical_20181030.DescribePHIDetectionJobGets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.
POST/#X-Amz-Target=ComprehendMedical_20181030.DescribeRxNormInferenceJobGets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.
POST/#X-Amz-Target=ComprehendMedical_20181030.DescribeSNOMEDCTInferenceJobGets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.
POST/#X-Amz-Target=ComprehendMedical_20181030.DetectEntitiesdeprecated<p>The <code>DetectEntities</code> operation is deprecated. You should use the <a>DetectEntitiesV2</a> operation instead.</p> <p> Inspects the clinical text for
POST/#X-Amz-Target=ComprehendMedical_20181030.DetectEntitiesV2<p>Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence sc
POST/#X-Amz-Target=ComprehendMedical_20181030.DetectPHIInspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amaz
POST/#X-Amz-Target=ComprehendMedical_20181030.InferICD10CMInferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowl
POST/#X-Amz-Target=ComprehendMedical_20181030.InferRxNormInferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National
POST/#X-Amz-Target=ComprehendMedical_20181030.InferSNOMEDCTInferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) o
POST/#X-Amz-Target=ComprehendMedical_20181030.ListEntitiesDetectionV2JobsGets a list of medical entity detection jobs that you have submitted.
POST/#X-Amz-Target=ComprehendMedical_20181030.ListICD10CMInferenceJobsGets a list of InferICD10CM jobs that you have submitted.
POST/#X-Amz-Target=ComprehendMedical_20181030.ListPHIDetectionJobsGets a list of protected health information (PHI) detection jobs that you have submitted.
POST/#X-Amz-Target=ComprehendMedical_20181030.ListRxNormInferenceJobsGets a list of InferRxNorm jobs that you have submitted.
POST/#X-Amz-Target=ComprehendMedical_20181030.ListSNOMEDCTInferenceJobsGets a list of InferSNOMEDCT jobs a user has submitted.
POST/#X-Amz-Target=ComprehendMedical_20181030.StartEntitiesDetectionV2JobStarts an asynchronous medical entity detection job for a collection of documents. Use the <code>DescribeEntitiesDetectionV2Job</code> operation to track the st
POST/#X-Amz-Target=ComprehendMedical_20181030.StartICD10CMInferenceJobStarts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the <code>DescribeICD10CMInferenceJob</code> operation to t
POST/#X-Amz-Target=ComprehendMedical_20181030.StartPHIDetectionJobStarts an asynchronous job to detect protected health information (PHI). Use the <code>DescribePHIDetectionJob</code> operation to track the status of a job.
POST/#X-Amz-Target=ComprehendMedical_20181030.StartRxNormInferenceJobStarts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the <code>DescribeRxNormInferenceJob</code> operation to trac
POST/#X-Amz-Target=ComprehendMedical_20181030.StartSNOMEDCTInferenceJobStarts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the statu
POST/#X-Amz-Target=ComprehendMedical_20181030.StopEntitiesDetectionV2JobStops a medical entities detection job in progress.
POST/#X-Amz-Target=ComprehendMedical_20181030.StopICD10CMInferenceJobStops an InferICD10CM inference job in progress.
POST/#X-Amz-Target=ComprehendMedical_20181030.StopPHIDetectionJobStops a protected health information (PHI) detection job in progress.
POST/#X-Amz-Target=ComprehendMedical_20181030.StopRxNormInferenceJobStops an InferRxNorm inference job in progress.
POST/#X-Amz-Target=ComprehendMedical_20181030.StopSNOMEDCTInferenceJobStops an InferSNOMEDCT inference job in progress.

Questions

Does the AWS Comprehend Medical API need an API key?

Yes. The AWS Comprehend Medical API uses API key authentication; the documentation explains how to get credentials.

Does the AWS Comprehend Medical API support HTTPS?

Yes, the AWS Comprehend Medical API is served over HTTPS.

How many endpoints does the AWS Comprehend Medical API have?

Its OpenAPI description lists 26 endpoints in version 2018-10-30. All of them are shown on this page.

What are alternatives to the AWS Comprehend Medical API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).