Cloud Healthcare API
Manage, store, and access healthcare data in Google Cloud Platform.
Healthcare#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Manage, store, and access healthcare data in Google Cloud Platform.
Endpoints 76
projects.locations.datasets.operations
- GETGets the latest state of a long-running operation
/v1/:nameGets 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. - POSTStarts asynchronous cancellation on a long-running operation
/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.datasets.fhirStores.fhir
- PUTUpdates the entire contents of a resource
/v1/:nameUpdates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4, R5). If the specified resource does not exist and… - POSTCreates a FHIR Binary resource
/v1/:parent/fhir/BinaryCreates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw… - GETReturns the consent enforcement status of all consent resources for a patient
/v1/:name/$consent-enforcement-status?_count=0&_page_token=stringReturns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a… - GETRetrieves a Patient resource and resources related to that patient
/v1/:name/$everything?_count=0&_page_token=string&_since=string&_type=string&end=string&start=stringRetrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4, R5). On… - DELETEDeletes all the historical versions of a resource (excluding the current version) from the FHIR store
/v1/:name/$purgeDeletes 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… - POSTValidates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store
/v1/:parent/fhir/:type/$validate?profile=stringValidates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate… - GETBulk exports all resources from the FHIR store to the specified destination
/v1/:name/fhir/$export?_since=string&_type=string&outputFormat=stringBulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide system level $export. The following… - GETGets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html),…
/v1/:name/fhir/metadataGets the FHIR capability statement (STU3, R4, R5), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality… - PUTIf a resource is found with the identifier specified in the query parameters, updates the entire contents of that…
/v1/:parent/fhir/:typeIf a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard… - POSTCreates a FHIR resource
/v1/:parent/fhir/:typeCreates a FHIR resource. Implements the FHIR standard create interaction (DSTU2, STU3, R4, R5), which creates a new resource with a server-assigned resource… - DELETEDeletes a FHIR resource that match an identifier search query
/v1/:parent/fhir/:typeDeletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional delete interaction, limited to searching by resource… - PATCHIf a resource is found with the identifier specified in the query parameters, updates part of that resource by…
/v1/:parent/fhir/:typeIf a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a JSON… - POSTExecutes all the requests in the given Bundle
/v1/:parent/fhirExecutes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4, R5). Supports all interactions… - GETLists all the versions of a resource (including the current version and deleted versions) from the FHIR store
/v1/:name/_history?_at=string&_count=0&_page_token=string&_since=stringLists 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… - POSTSearches for resources in the given FHIR store according to criteria specified as query parameters
/v1/:parent/fhir/_search?resourceType=stringSearches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2,… - POSTSearches for resources in the given FHIR store according to criteria specified as query parameters
/v1/:parent/fhir/:resourceType/_searchSearches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2,…
projects.locations.datasets.hl7V2Stores.messages
- DELETEDeletes an HL7v2 message.
/v1/:nameDeletes an HL7v2 message. - PATCHUpdate the message
/v1/:name?updateMask=stringUpdate the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the… - GETLists all the messages in the given HL7v2 store with support for filtering
/v1/:parent/messages?filter=string&orderBy=string&pageSize=0&pageToken=string&view=MESSAGE_VIEW_UNSPECIFIEDLists 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… - POSTParses and stores an HL7v2 message
/v1/:parent/messagesParses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig,… - POSTParses and stores an HL7v2 message
/v1/:parent/messages:ingestParses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig,…
projects.locations
- GETLists information about the supported locations for this service
/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
projects.locations.datasets
- GETLists the health datasets in the current project.
/v1/:parent/datasets?pageSize=0&pageToken=stringLists the health datasets in the current project. - POSTCreates a new health dataset
/v1/:parent/datasets?datasetId=stringCreates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or… - POSTCreates a new dataset containing de-identified data from the source dataset
/v1/:sourceDataset:deidentifyCreates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the…
projects.locations.datasets.hl7V2Stores
- GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/:resource:testIamPermissionsReturns 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… - POSTExports the messages to a destination
/v1/:name:exportExports 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… - POSTImport messages to the HL7v2 store by loading data from the specified sources
/v1/:name:importImport messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import… - POSTRolls back messages from the HL7v2 store to the specified time
/v1/:name:rollbackRolls back messages from the HL7v2 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by… - GETLists the HL7v2 stores in the given dataset.
/v1/:parent/hl7V2Stores?filter=string&pageSize=0&pageToken=stringLists the HL7v2 stores in the given dataset. - POSTCreates a new HL7v2 store within the parent dataset.
/v1/:parent/hl7V2Stores?hl7V2StoreId=stringCreates a new HL7v2 store within the parent dataset. - GETGets metrics associated with the HL7v2 store.
/v1/:name:getHL7v2StoreMetricsGets metrics associated with the HL7v2 store.
projects.locations.datasets.consentStores
- POSTChecks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
/v1/:consentStore:checkDataAccessChecks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use. - GETLists the consent stores in the specified dataset.
/v1/:parent/consentStores?filter=string&pageSize=0&pageToken=stringLists the consent stores in the specified dataset. - POSTCreates a new consent store in the parent dataset
/v1/:parent/consentStores?consentStoreId=stringCreates 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… - POSTEvaluates the user's Consents for all matching User data mappings
/v1/:consentStore:evaluateUserConsentsEvaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between… - POSTQueries all data_ids that are consented for a specified use in the given consent store and writes them to a specified…
/v1/:consentStore:queryAccessibleDataQueries 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…
projects.locations.datasets.consentStores.attributeDefinitions
- GETLists the Attribute definitions in the specified consent store.
/v1/:parent/attributeDefinitions?filter=string&pageSize=0&pageToken=stringLists the Attribute definitions in the specified consent store. - POSTCreates a new Attribute definition in the parent consent store.
/v1/:parent/attributeDefinitions?attributeDefinitionId=stringCreates a new Attribute definition in the parent consent store.
projects.locations.datasets.consentStores.consentArtifacts
- GETLists the Consent artifacts in the specified consent store.
/v1/:parent/consentArtifacts?filter=string&pageSize=0&pageToken=stringLists the Consent artifacts in the specified consent store. - POSTCreates a new Consent artifact in the parent consent store.
/v1/:parent/consentArtifactsCreates a new Consent artifact in the parent consent store.
projects.locations.datasets.consentStores.consents
- POSTActivates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`
/v1/:name:activateActivates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the specified… - GETLists the Consent in the given consent store, returning each Consent's latest revision.
/v1/:parent/consents?filter=string&pageSize=0&pageToken=stringLists the Consent in the given consent store, returning each Consent's latest revision. - POSTCreates a new Consent in the parent consent store.
/v1/:parent/consentsCreates a new Consent in the parent consent store. - DELETEDeletes the specified revision of a Consent
/v1/:name:deleteRevisionDeletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision. - GETLists the revisions of the specified Consent in reverse chronological order.
/v1/:name:listRevisions?filter=string&pageSize=0&pageToken=stringLists the revisions of the specified Consent in reverse chronological order. - POSTRejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`
/v1/:name:rejectRejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified… - POSTRevokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`
/v1/:name:revokeRevokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the specified…
projects.locations.datasets.consentStores.userDataMappings
- POSTArchives the specified User data mapping.
/v1/:name:archiveArchives the specified User data mapping. - GETLists the User data mappings in the specified consent store.
/v1/:parent/userDataMappings?filter=string&pageSize=0&pageToken=stringLists the User data mappings in the specified consent store. - POSTCreates a new User data mapping in the parent consent store.
/v1/:parent/userDataMappingsCreates a new User data mapping in the parent consent store.
projects.locations.datasets.dicomStores
- GETLists the DICOM stores in the given dataset.
/v1/:parent/dicomStores?filter=string&pageSize=0&pageToken=stringLists the DICOM stores in the given dataset. - POSTCreates a new DICOM store within the parent dataset.
/v1/:parent/dicomStores?dicomStoreId=stringCreates a new DICOM store within the parent dataset. - GETGets metrics associated with the DICOM store.
/v1/:name:getDICOMStoreMetricsGets metrics associated with the DICOM store.
projects.locations.datasets.fhirStores
- POSTDe-identifies data from the source store and writes it to the destination store
/v1/:sourceStore:deidentifyDe-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful,… - POSTApplies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store…
/v1/:name:applyAdminConsentsApplies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This… - POSTApply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the…
/v1/:name:applyConsentsApply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate… - GETBulk exports a Group resource and resources in the member field, including related resources for each Patient member
/v1/:name/$export?_since=string&_type=string&organizeOutputBy=string&outputFormat=stringBulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical… - POSTBulk deletes the FHIR resources from the given FHIR store
/v1/:name:bulkDeleteBulk deletes the FHIR resources from the given FHIR store. This method returns an Operation that can be used to track the progress of the deletion by calling… - GETLists the FHIR stores in the given dataset.
/v1/:parent/fhirStores?filter=string&pageSize=0&pageToken=stringLists the FHIR stores in the given dataset. - POSTCreates a new FHIR store within the parent dataset.
/v1/:parent/fhirStores?fhirStoreId=stringCreates a new FHIR store within the parent dataset. - GETExplains all the permitted/denied actor, purpose and environment for a given resource
/v1/:name:explainDataAccess?resourceId=stringExplains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not supported in DSTU2 or R5. - GETGets metrics associated with the FHIR store.
/v1/:name:getFHIRStoreMetricsGets metrics associated with the FHIR store.
projects.locations.datasets.dicomStores.studies.series.instances.frames
- GETRetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers…
/v1/:parent/dicomWeb/:dicomWebPath?viewport=stringRetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See…
projects.locations.datasets.dicomStores.studies
- POSTStoreInstances stores DICOM instances associated with study instance unique identifiers (SUID)
/v1/:parent/dicomWeb/:dicomWebPathStoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction]…
projects.locations.datasets.dicomStores.studies.series.instances
- DELETEDeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID
/v1/:parent/dicomWeb/:dicomWebPathDeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified…
projects.locations.datasets.dicomStores.dicomWeb.studies
- POSTSetBlobStorageSettings sets the blob storage settings of the specified resources.
/v1/:resource:setBlobStorageSettingsSetBlobStorageSettings sets the blob storage settings of the specified resources. - GETGetStudyMetrics returns metrics for a study.
/v1/:study:getStudyMetricsGetStudyMetrics returns metrics for a study.
projects.locations.datasets.dicomStores.dicomWeb.studies.series
- GETGetSeriesMetrics returns metrics for a series.
/v1/:series:getSeriesMetricsGetSeriesMetrics returns metrics for a series.
projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances
- GETGetStorageInfo returns the storage info of the specified resource.
/v1/:resource:getStorageInfoGetStorageInfo returns the storage info of the specified resource.
projects.locations.services.nlp
- POSTAnalyze heathcare entity in a document
/v1/:nlpService:analyzeEntitiesAnalyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context…
API details
- Base URL
https://healthcare.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 76 operations on 58 pathsPOST 38GET 29DELETE 5PUT 2PATCH 2
- Main resources
- projects.locations.datasets.fhirStores.fhir 16projects.locations.datasets.fhirStores 9projects.locations.datasets.hl7V2Stores 9projects.locations.datasets.consentStores.consents 7projects.locations.datasets.consentStores 5projects.locations.datasets.hl7V2Stores.messages 5projects.locations.datasets 3projects.locations.datasets.consentStores.userDataMappings 3projects.locations.datasets.dicomStores 3projects.locations.datasets.operations 3
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Healthcare API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Healthcare API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the latest state of a long-running operation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Healthcare API?
Manage, store, and access healthcare data in Google Cloud Platform. It is listed under Healthcare and has 76 endpoints.
Who publishes the Cloud Healthcare API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Healthcare API?
Requests go to https://healthcare.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Healthcare API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Cloud Healthcare API have?
76 operations on 58 paths (38 POST, 29 GET, 5 DELETE, 2 PUT, 2 PATCH). The largest groups are projects.locations.datasets.fhirStores.fhir, projects.locations.datasets.fhirStores, projects.locations.datasets.hl7V2Stores, projects.locations.datasets.consentStores.consents.
Is forking the Cloud Healthcare API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.