Cloud Healthcare API API

by googleapis.com

Overview

Manage, store, and access healthcare data in Google Cloud Platform.

Cloud Healthcare API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 72 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Analytics
Base URL: https://healthcare.googleapis.com/
Version: v1beta1
Endpoints: 72
OpenAPI: Specification ↗
Spec updated: 2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://healthcare.googleapis.com/v1beta1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://healthcare.googleapis.com/v1beta1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://healthcare.googleapis.com/v1beta1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
POST	`/v1beta1/{consentStore}:checkDataAccess`	Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
POST	`/v1beta1/{consentStore}:evaluateUserConsents`	Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between t
POST	`/v1beta1/{consentStore}:queryAccessibleData`	Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includ
GET	`/v1beta1/{name}`	Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
PUT	`/v1beta1/{name}`	Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#upd
PATCH	`/v1beta1/{name}`	Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can't be altered. Only the Mess
DELETE	`/v1beta1/{name}`	Deletes an HL7v2 message.
GET	`/v1beta1/{name}/$everything`	Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement
DELETE	`/v1beta1/{name}/$purge`	Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the cu
GET	`/v1beta1/{name}/$translate`	Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system.
GET	`/v1beta1/{name}/_history`	Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR stan
GET	`/v1beta1/{name}/fhir/metadata`	Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhi
GET	`/v1beta1/{name}/locations`	Lists information about the supported locations for this service.
GET	`/v1beta1/{name}/operations`	Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST	`/v1beta1/{name}:activate`	Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the specified Co
POST	`/v1beta1/{name}:archive`	Archives the specified User data mapping.
POST	`/v1beta1/{name}:cancel`	Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv
POST	`/v1beta1/{name}:configureSearch`	Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters pro
DELETE	`/v1beta1/{name}:deleteRevision`	Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.
POST	`/v1beta1/{name}:evaluate`	Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type Evaluate
POST	`/v1beta1/{name}:export`	Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time
GET	`/v1beta1/{name}:getFHIRStoreMetrics`	Gets metrics associated with the FHIR store.
POST	`/v1beta1/{name}:import`	Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics
GET	`/v1beta1/{name}:listRevisions`	Lists the revisions of the specified Consent in reverse chronological order.
POST	`/v1beta1/{name}:reject`	Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Co
POST	`/v1beta1/{name}:revoke`	Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the specified Con
POST	`/v1beta1/{nlpService}:analyzeEntities`	Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aw
GET	`/v1beta1/{parent}/annotationStores`	Lists the Annotation stores in the given dataset for a source store.
POST	`/v1beta1/{parent}/annotationStores`	Creates a new Annotation store within the parent dataset.
GET	`/v1beta1/{parent}/annotations`	Lists the Annotations in the given Annotation store for a source resource.
POST	`/v1beta1/{parent}/annotations`	Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by thi
GET	`/v1beta1/{parent}/attributeDefinitions`	Lists the Attribute definitions in the specified consent store.
POST	`/v1beta1/{parent}/attributeDefinitions`	Creates a new Attribute definition in the parent consent store.
GET	`/v1beta1/{parent}/consentArtifacts`	Lists the Consent artifacts in the specified consent store.
POST	`/v1beta1/{parent}/consentArtifacts`	Creates a new Consent artifact in the parent consent store.
GET	`/v1beta1/{parent}/consentStores`	Lists the consent stores in the specified dataset.
POST	`/v1beta1/{parent}/consentStores`	Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error
GET	`/v1beta1/{parent}/consents`	Lists the Consent in the given consent store, returning each Consent's latest revision.
POST	`/v1beta1/{parent}/consents`	Creates a new Consent in the parent consent store.
GET	`/v1beta1/{parent}/datasets`	Lists the health datasets in the current project.
POST	`/v1beta1/{parent}/datasets`	Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Ope
GET	`/v1beta1/{parent}/dicomStores`	Lists the DICOM stores in the given dataset.
POST	`/v1beta1/{parent}/dicomStores`	Creates a new DICOM store within the parent dataset.
GET	`/v1beta1/{parent}/dicomWeb/{dicomWebPath}`	RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [
POST	`/v1beta1/{parent}/dicomWeb/{dicomWebPath}`	StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/curr
DELETE	`/v1beta1/{parent}/dicomWeb/{dicomWebPath}`	DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified i
POST	`/v1beta1/{parent}/fhir`	Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU
GET	`/v1beta1/{parent}/fhir/$references`	Gets all incoming references to a given target FHIR resource. Can also get all incoming references when the target resource does not exist, for example, if the
GET	`/v1beta1/{parent}/fhir/ConceptMap/$translate`	Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://ww
GET	`/v1beta1/{parent}/fhir/Observation/$lastn`	Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted
POST	`/v1beta1/{parent}/fhir/_search`	Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](htt
POST	`/v1beta1/{parent}/fhir/{resourceType}/_search`	Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](htt
POST	`/v1beta1/{parent}/fhir/{type}`	Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](https
PUT	`/v1beta1/{parent}/fhir/{type}`	If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standar
PATCH	`/v1beta1/{parent}/fhir/{type}`	If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [
DELETE	`/v1beta1/{parent}/fhir/{type}`	Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/
POST	`/v1beta1/{parent}/fhir/{type}/$validate`	Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate (
GET	`/v1beta1/{parent}/fhirStores`	Lists the FHIR stores in the given dataset.
POST	`/v1beta1/{parent}/fhirStores`	Creates a new FHIR store within the parent dataset.
GET	`/v1beta1/{parent}/hl7V2Stores`	Lists the HL7v2 stores in the given dataset.
POST	`/v1beta1/{parent}/hl7V2Stores`	Creates a new HL7v2 store within the parent dataset.
GET	`/v1beta1/{parent}/messages`	Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay be
POST	`/v1beta1/{parent}/messages`	Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if
GET	`/v1beta1/{parent}/messages:batchGet`	Gets multiple messages in the given HL7v2 store.
POST	`/v1beta1/{parent}/messages:ingest`	Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if
GET	`/v1beta1/{parent}/userDataMappings`	Lists the User data mappings in the specified consent store.
POST	`/v1beta1/{parent}/userDataMappings`	Creates a new User data mapping in the parent consent store.
GET	`/v1beta1/{resource}:getIamPolicy`	Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
POST	`/v1beta1/{resource}:setIamPolicy`	Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` erro
POST	`/v1beta1/{resource}:testIamPermissions`	Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND`
POST	`/v1beta1/{sourceDataset}:deidentify`	Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the res
POST	`/v1beta1/{sourceStore}:deidentify`	De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the

Questions

Does the Cloud Healthcare API API need an API key?

Yes. The Cloud Healthcare API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Healthcare API API support HTTPS?

Yes, the Cloud Healthcare API API is served over HTTPS.

How many endpoints does the Cloud Healthcare API API have?

Its OpenAPI description lists 72 endpoints in version v1beta1. All of them are shown on this page.

What are alternatives to the Cloud Healthcare API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).

Overview

At a glance

Make a first request

Endpoints

Questions

Similar analytics APIs

Google Play Integrity API

versionhistory.googleapis.com API

Doc Converter

Perspective Comment Analyzer API

Safe Browsing API

Web Fonts Developer API