Manage, store, and access healthcare data in Google Cloud Platform.
Service: healthcare.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries . If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
-
https://healthcare.googleapis.com
REST Resource: v1beta1.projects.locations
Methods | |
---|---|
get
|
GET /v1beta1/{name=projects/*/locations/*}
Gets information about a location. |
list
|
GET /v1beta1/{name=projects/*}/locations
Lists information about the supported locations for this service. |
REST Resource: v1beta1.projects.locations.datasets
Methods | |
---|---|
create
|
POST /v1beta1/{parent=projects/*/locations/*}/datasets
Creates a new health dataset. |
deidentify
|
POST /v1beta1/{sourceDataset=projects/*/locations/*/datasets/*}:deidentify
Creates a new dataset containing de-identified data from the source dataset. |
delete
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*}
Deletes the specified health dataset and all data contained in the dataset. |
get
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*}
Gets any metadata associated with a dataset. |
getIamPolicy
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*}:getIamPolicy
Gets the access control policy for a resource. |
list
|
GET /v1beta1/{parent=projects/*/locations/*}/datasets
Lists the health datasets in the current project. |
patch
|
PATCH /v1beta1/{dataset.name=projects/*/locations/*/datasets/*}
Updates dataset metadata. |
setIamPolicy
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.annotationStores
Methods | |
---|---|
getIamPolicy
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*/annotationStores/*}:getIamPolicy
Gets the access control policy for a resource. |
setIamPolicy
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/annotationStores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/annotationStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.dataMapperWorkspaces
Methods | |
---|---|
getIamPolicy
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:getIamPolicy
Gets the access control policy for a resource. |
setIamPolicy
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores
Methods | |
---|---|
create
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/dicomStores
Creates a new DICOM store within the parent dataset. |
deidentify
|
POST /v1beta1/{sourceStore=projects/*/locations/*/datasets/*/dicomStores/*}:deidentify
De-identifies data from the source store and writes it to the destination store. |
delete
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/dicomStores/*}
Deletes the specified DICOM store and removes all images that are contained within it. |
export
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:export
Exports data to the specified destination by copying it from the DICOM store. |
get
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/dicomStores/*}
Gets the specified DICOM store. |
getDICOMStoreMetrics
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:getDICOMStoreMetrics
Gets metrics associated with the DICOM store. |
getIamPolicy
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:getIamPolicy
Gets the access control policy for a resource. |
import
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:import
Imports data into the DICOM store by copying it from the specified source. |
list
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/dicomStores
Lists the DICOM stores in the given dataset. |
patch
|
PATCH /v1beta1/{dicomStore.name=projects/*/locations/*/datasets/*/dicomStores/*}
Updates the specified DICOM store. |
searchForInstances
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=instances}
SearchForInstances returns a list of matching instances. |
searchForSeries
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=series}
SearchForSeries returns a list of matching series. |
searchForStudies
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies}
SearchForStudies returns a list of matching studies. |
setBlobStorageSettings
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setBlobStorageSettings
SetBlobStorageSettings sets the blob storage settings of the specified resources. |
setIamPolicy
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
storeInstances
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). |
testIamPermissions
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.dicomWeb.studies
Methods | |
---|---|
getStudyMetrics
|
GET /v1beta1/{study=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*}:getStudyMetrics
GetStudyMetrics returns metrics for a study. |
setBlobStorageSettings
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/**}:setBlobStorageSettings
SetBlobStorageSettings sets the blob storage settings of the specified resources. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.dicomWeb.studies.series
Methods | |
---|---|
getSeriesMetrics
|
GET /v1beta1/{series=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*/series/*}:getSeriesMetrics
GetSeriesMetrics returns metrics for a series. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances
Methods | |
---|---|
getStorageInfo
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*/series/*/instances/*}:getStorageInfo
GetStorageInfo returns the storage info of the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.studies
Methods | |
---|---|
delete
|
DELETE /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
DeleteStudy deletes all instances within the given study using a long running operation. |
retrieveMetadata
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/metadata}
RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. |
retrieveStudy
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
RetrieveStudy returns all instances within the given study. |
searchForInstances
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/instances}
SearchForInstances returns a list of matching instances. |
searchForSeries
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series}
SearchForSeries returns a list of matching series. |
storeInstances
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.studies.series
Methods | |
---|---|
delete
|
DELETE /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}
DeleteSeries deletes all instances within the given study and series using a long running operation. |
retrieveMetadata
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/metadata}
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. |
retrieveSeries
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}
RetrieveSeries returns all instances within the given study and series. |
searchForInstances
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances}
SearchForInstances returns a list of matching instances. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.studies.series.instances
Methods | |
---|---|
delete
|
DELETE /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. |
retrieveInstance
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. |
retrieveMetadata
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/metadata}
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. |
retrieveRendered
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/rendered}
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata
Methods | |
---|---|
retrieveBulkdata
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/bulkdata/*/**}
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. |
REST Resource: v1beta1.projects.locations.datasets.dicomStores.studies.series.instances.frames
Methods | |
---|---|
retrieveFrames
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*}
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. |
retrieveRendered
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*/rendered}
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. |
REST Resource: v1beta1.projects.locations.datasets.fhirStores
Methods | |
---|---|
applyAdminConsents
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:applyAdminConsents
Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. |
applyConsents
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:applyConsents
Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. |
bulk-export-group
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Group/*}/$export
Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. |
configureSearch
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:configureSearch
Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. |
create
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/fhirStores
Creates a new FHIR store within the parent dataset. |
deidentify
|
POST /v1beta1/{sourceStore=projects/*/locations/*/datasets/*/fhirStores/*}:deidentify
De-identifies data from the source store and writes it to the destination store. |
delete
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Deletes the specified FHIR store and removes all resources within it. |
explainDataAccess
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:explainDataAccess
Explains all the permitted/denied actor, purpose and environment for a given resource. |
export
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export
Export resources from the FHIR store to the specified destination. |
exportHistory
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:exportHistory
Export resources including historical versions from the FHIR store to the specified destination. |
get
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Gets the configuration of the specified FHIR store. |
getFHIRStoreMetrics
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:getFHIRStoreMetrics
Gets metrics associated with the FHIR store. |
getIamPolicy
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:getIamPolicy
Gets the access control policy for a resource. |
import
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:import
Import resources to the FHIR store by loading data from the specified sources. |
importHistory
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:importHistory
Import resource historical versions from Cloud Storage source to destination fhir store. |
list
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/fhirStores
Lists the FHIR stores in the given dataset. |
patch
|
PATCH /v1beta1/{fhirStore.name=projects/*/locations/*/datasets/*/fhirStores/*}
Updates the configuration of the specified FHIR store. |
rollback
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:rollback
Rolls back resources from the FHIR store to the specified time. |
setIamPolicy
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.fhirStores.fhir
Methods | |
---|---|
Binary-create
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/Binary
Creates a FHIR Binary resource. |
Binary-read
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Binary/*}
Gets the contents of a FHIR Binary resource. |
Binary-update
|
PUT /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Binary/*}
Updates the entire contents of a Binary resource. |
Binary-vread
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Binary/*/_history/*}
Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. |
ConceptMap-search-translate
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/ConceptMap/$translate
Translates a code from one value set to another by searching for appropriate concept maps. |
ConceptMap-translate
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/ConceptMap/*}/$translate
Translates a code from one value set to another using a concept map. |
Consent-enforcement-status
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Consent/*}/$consent-enforcement-status
Returns the consent enforcement status of a single consent resource. |
Encounter-everything
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Encounter/*}/$everything
Retrieves an Encounter resource and resources related to that Encounter. |
Observation-lastn
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/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 from most recent to oldest. |
Patient-consent-enforcement-status
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$consent-enforcement-status
Returns the consent enforcement status of all consent resources for a patient. |
Patient-everything
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everything
Retrieves a Patient resource and resources related to that patient. |
Resource-incoming-references
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$references
Lists all the resources that directly refer to the given target FHIR resource. |
Resource-purge
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/$purge
Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. |
Resource-validate
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}/$validate
Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. |
bulk-export
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$export
Bulk exports all resources from the FHIR store to the specified destination. |
capabilities
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/metadata
Gets the FHIR capability statement ( STU3 , R4 , R5 ), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. |
conditionalDelete
|
DELETE /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
Deletes FHIR resources that match a search query. |
conditionalPatch
|
PATCH /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/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 JSON Patch document. |
conditionalUpdate
|
PUT /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. |
create
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
Creates a FHIR resource. |
delete
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Deletes a FHIR resource. |
executeBundle
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir
Executes all the requests in the given Bundle. |
history
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/_history
Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. |
patch
|
PATCH /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Updates part of an existing resource by applying the operations specified in a JSON Patch document. |
read
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Gets the contents of a FHIR resource. |
search
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{resourceType}
Searches for resources in the given FHIR store according to criteria specified as query parameters. |
search-type
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{resourceType}/_search
Searches for resources in the given FHIR store according to criteria specified as query parameters. |
update
|
PUT /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Updates the entire contents of a resource. |
vread
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*/_history/*}
Gets the contents of a version (current or historical) of a FHIR resource by version ID. |
REST Resource: v1beta1.projects.locations.datasets.fhirStores.operations
Methods | |
---|---|
delete-fhir-operation
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/operations/*}
Deletes operations as defined in the FHIR specification. |
get-fhir-operation-status
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/operations/*}
Gets the status of operations as defined in the FHIR specification. |
REST Resource: v1beta1.projects.locations.datasets.hl7V2Stores
Methods | |
---|---|
create
|
POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/hl7V2Stores
Creates a new HL7v2 store within the parent dataset. |
delete
|
DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Deletes the specified HL7v2 store and removes all messages that it contains. |
export
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:export
Exports the messages to a destination. |
get
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Gets the specified HL7v2 store. |
getHL7v2StoreMetrics
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getHL7v2StoreMetrics
Gets metrics associated with the HL7v2 store. |
getIamPolicy
|
GET /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getIamPolicy
Gets the access control policy for a resource. |
import
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:import
Import messages to the HL7v2 store by loading data from the specified sources. |
list
|
GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/hl7V2Stores
Lists the HL7v2 stores in the given dataset. |
patch
|
PATCH /v1beta1/{hl7V2Store.name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Updates the HL7v2 store. |
rollback
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:rollback
Rolls back messages from the HL7v2 store to the specified time. |
setIamPolicy
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1beta1.projects.locations.datasets.operations
Methods | |
---|---|
cancel
|
POST /v1beta1/{name=projects/*/locations/*/datasets/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1beta1/{name=projects/*/locations/*/datasets/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1beta1.projects.locations.services.nlp
Methods | |
---|---|
analyzeEntities
|
POST /v1beta1/{nlpService=projects/*/locations/*/services/nlp}:analyzeEntities
Analyze heathcare entity in a document. |
REST Resource: v1.projects.locations
Methods | |
---|---|
get
|
GET /v1/{name=projects/*/locations/*}
Gets information about a location. |
list
|
GET /v1/{name=projects/*}/locations
Lists information about the supported locations for this service. |
REST Resource: v1.projects.locations.datasets
Methods | |
---|---|
create
|
POST /v1/{parent=projects/*/locations/*}/datasets
Creates a new health dataset. |
deidentify
|
POST /v1/{sourceDataset=projects/*/locations/*/datasets/*}:deidentify
Creates a new dataset containing de-identified data from the source dataset. |
delete
|
DELETE /v1/{name=projects/*/locations/*/datasets/*}
Deletes the specified health dataset and all data contained in the dataset. |
get
|
GET /v1/{name=projects/*/locations/*/datasets/*}
Gets any metadata associated with a dataset. |
getIamPolicy
|
GET /v1/{resource=projects/*/locations/*/datasets/*}:getIamPolicy
Gets the access control policy for a resource. |
list
|
GET /v1/{parent=projects/*/locations/*}/datasets
Lists the health datasets in the current project. |
patch
|
PATCH /v1/{dataset.name=projects/*/locations/*/datasets/*}
Updates dataset metadata. |
setIamPolicy
|
POST /v1/{resource=projects/*/locations/*/datasets/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1/{resource=projects/*/locations/*/datasets/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1.projects.locations.datasets.dataMapperWorkspaces
Methods | |
---|---|
getIamPolicy
|
GET /v1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:getIamPolicy
Gets the access control policy for a resource. |
setIamPolicy
|
POST /v1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1.projects.locations.datasets.dicomStores
Methods | |
---|---|
create
|
POST /v1/{parent=projects/*/locations/*/datasets/*}/dicomStores
Creates a new DICOM store within the parent dataset. |
deidentify
|
POST /v1/{sourceStore=projects/*/locations/*/datasets/*/dicomStores/*}:deidentify
De-identifies data from the source store and writes it to the destination store. |
delete
|
DELETE /v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}
Deletes the specified DICOM store and removes all images that are contained within it. |
export
|
POST /v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:export
Exports data to the specified destination by copying it from the DICOM store. |
get
|
GET /v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}
Gets the specified DICOM store. |
getDICOMStoreMetrics
|
GET /v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:getDICOMStoreMetrics
Gets metrics associated with the DICOM store. |
getIamPolicy
|
GET /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:getIamPolicy
Gets the access control policy for a resource. |
import
|
POST /v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:import
Imports data into the DICOM store by copying it from the specified source. |
list
|
GET /v1/{parent=projects/*/locations/*/datasets/*}/dicomStores
Lists the DICOM stores in the given dataset. |
patch
|
PATCH /v1/{dicomStore.name=projects/*/locations/*/datasets/*/dicomStores/*}
Updates the specified DICOM store. |
searchForInstances
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=instances}
SearchForInstances returns a list of matching instances. |
searchForSeries
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=series}
SearchForSeries returns a list of matching series. |
searchForStudies
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies}
SearchForStudies returns a list of matching studies. |
setBlobStorageSettings
|
POST /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setBlobStorageSettings
SetBlobStorageSettings sets the blob storage settings of the specified resources. |
setIamPolicy
|
POST /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
storeInstances
|
POST /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). |
testIamPermissions
|
POST /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1.projects.locations.datasets.dicomStores.dicomWeb.studies
Methods | |
---|---|
getStudyMetrics
|
GET /v1/{study=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*}:getStudyMetrics
GetStudyMetrics returns metrics for a study. |
setBlobStorageSettings
|
POST /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/**}:setBlobStorageSettings
SetBlobStorageSettings sets the blob storage settings of the specified resources. |
REST Resource: v1.projects.locations.datasets.dicomStores.dicomWeb.studies.series
Methods | |
---|---|
getSeriesMetrics
|
GET /v1/{series=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*/series/*}:getSeriesMetrics
GetSeriesMetrics returns metrics for a series. |
REST Resource: v1.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances
Methods | |
---|---|
getStorageInfo
|
GET /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*/series/*/instances/*}:getStorageInfo
GetStorageInfo returns the storage info of the specified resource. |
REST Resource: v1.projects.locations.datasets.dicomStores.studies
Methods | |
---|---|
delete
|
DELETE /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
DeleteStudy deletes all instances within the given study. |
retrieveMetadata
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/metadata}
RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. |
retrieveStudy
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
RetrieveStudy returns all instances within the given study. |
searchForInstances
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/instances}
SearchForInstances returns a list of matching instances. |
searchForSeries
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series}
SearchForSeries returns a list of matching series. |
storeInstances
|
POST /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). |
REST Resource: v1.projects.locations.datasets.dicomStores.studies.series
Methods | |
---|---|
delete
|
DELETE /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}
DeleteSeries deletes all instances within the given study and series. |
retrieveMetadata
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/metadata}
RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. |
retrieveSeries
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}
RetrieveSeries returns all instances within the given study and series. |
searchForInstances
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances}
SearchForInstances returns a list of matching instances. |
REST Resource: v1.projects.locations.datasets.dicomStores.studies.series.instances
Methods | |
---|---|
delete
|
DELETE /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. |
retrieveInstance
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. |
retrieveMetadata
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/metadata}
RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. |
retrieveRendered
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/rendered}
RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. |
REST Resource: v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata
Methods | |
---|---|
retrieveBulkdata
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/bulkdata/*/**}
Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. |
REST Resource: v1.projects.locations.datasets.dicomStores.studies.series.instances.frames
Methods | |
---|---|
retrieveFrames
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*}
RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. |
retrieveRendered
|
GET /v1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*/frames/*/rendered}
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. |
REST Resource: v1.projects.locations.datasets.fhirStores
Methods | |
---|---|
applyAdminConsents
|
POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:applyAdminConsents
Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. |
applyConsents
|
POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:applyConsents
Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. |
bulk-export-group
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Group/*}/$export
Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. |
create
|
POST /v1/{parent=projects/*/locations/*/datasets/*}/fhirStores
Creates a new FHIR store within the parent dataset. |
deidentify
|
POST /v1/{sourceStore=projects/*/locations/*/datasets/*/fhirStores/*}:deidentify
De-identifies data from the source store and writes it to the destination store. |
delete
|
DELETE /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Deletes the specified FHIR store and removes all resources within it. |
explainDataAccess
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:explainDataAccess
Explains all the permitted/denied actor, purpose and environment for a given resource. |
export
|
POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export
Export resources from the FHIR store to the specified destination. |
get
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Gets the configuration of the specified FHIR store. |
getFHIRStoreMetrics
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:getFHIRStoreMetrics
Gets metrics associated with the FHIR store. |
getIamPolicy
|
GET /v1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:getIamPolicy
Gets the access control policy for a resource. |
import
|
POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:import
Imports resources to the FHIR store by loading data from the specified sources. |
list
|
GET /v1/{parent=projects/*/locations/*/datasets/*}/fhirStores
Lists the FHIR stores in the given dataset. |
patch
|
PATCH /v1/{fhirStore.name=projects/*/locations/*/datasets/*/fhirStores/*}
Updates the configuration of the specified FHIR store. |
rollback
|
POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:rollback
Rolls back resources from the FHIR store to the specified time. |
setIamPolicy
|
POST /v1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1.projects.locations.datasets.fhirStores.fhir
Methods | |
---|---|
Binary-create
|
POST /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/Binary
Creates a FHIR Binary resource. |
Binary-read
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Binary/*}
Gets the contents of a FHIR Binary resource. |
Binary-update
|
PUT /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Binary/*}
Updates the entire contents of a Binary resource. |
Binary-vread
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Binary/*/_history/*}
Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. |
Consent-enforcement-status
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Consent/*}/$consent-enforcement-status
Returns the consent enforcement status of a single consent resource. |
Patient-consent-enforcement-status
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$consent-enforcement-status
Returns the consent enforcement status of all consent resources for a patient. |
Patient-everything
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everything
Retrieves a Patient resource and resources related to that patient. |
Resource-purge
|
DELETE /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/$purge
Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. |
Resource-validate
|
POST /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}/$validate
Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. |
bulk-export
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$export
Bulk exports all resources from the FHIR store to the specified destination. |
capabilities
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/metadata
Gets the FHIR capability statement ( STU3 , R4 , R5 ), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. |
conditionalDelete
|
DELETE /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
Deletes a FHIR resource that match an identifier search query. |
conditionalPatch
|
PATCH /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
If 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 Patch document. |
conditionalUpdate
|
PUT /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. |
create
|
POST /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
Creates a FHIR resource. |
delete
|
DELETE /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Deletes a FHIR resource. |
executeBundle
|
POST /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir
Executes all the requests in the given Bundle. |
history
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/_history
Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. |
patch
|
PATCH /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Updates part of an existing resource by applying the operations specified in a JSON Patch document. |
read
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Gets the contents of a FHIR resource. |
search
|
GET /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{resourceType}
Searches for resources in the given FHIR store according to criteria specified as query parameters. |
search-type
|
POST /v1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{resourceType}/_search
Searches for resources in the given FHIR store according to criteria specified as query parameters. |
update
|
PUT /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Updates the entire contents of a resource. |
vread
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*/_history/*}
Gets the contents of a version (current or historical) of a FHIR resource by version ID. |
REST Resource: v1.projects.locations.datasets.fhirStores.operations
Methods | |
---|---|
delete-fhir-operation
|
DELETE /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/operations/*}
Deletes operations as defined in the FHIR specification. |
get-fhir-operation-status
|
GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/operations/*}
Gets the status of operations as defined in the FHIR specification. |
REST Resource: v1.projects.locations.datasets.hl7V2Stores
Methods | |
---|---|
create
|
POST /v1/{parent=projects/*/locations/*/datasets/*}/hl7V2Stores
Creates a new HL7v2 store within the parent dataset. |
delete
|
DELETE /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Deletes the specified HL7v2 store and removes all messages that it contains. |
export
|
POST /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:export
Exports the messages to a destination. |
get
|
GET /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Gets the specified HL7v2 store. |
getHL7v2StoreMetrics
|
GET /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getHL7v2StoreMetrics
Gets metrics associated with the HL7v2 store. |
getIamPolicy
|
GET /v1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getIamPolicy
Gets the access control policy for a resource. |
import
|
POST /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:import
Import messages to the HL7v2 store by loading data from the specified sources. |
list
|
GET /v1/{parent=projects/*/locations/*/datasets/*}/hl7V2Stores
Lists the HL7v2 stores in the given dataset. |
patch
|
PATCH /v1/{hl7V2Store.name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Updates the HL7v2 store. |
rollback
|
POST /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:rollback
Rolls back messages from the HL7v2 store to the specified time. |
setIamPolicy
|
POST /v1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:setIamPolicy
Sets the access control policy on the specified resource. |
testIamPermissions
|
POST /v1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource. |
REST Resource: v1.projects.locations.datasets.operations
Methods | |
---|---|
cancel
|
POST /v1/{name=projects/*/locations/*/datasets/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation. |
get
|
GET /v1/{name=projects/*/locations/*/datasets/*/operations/*}
Gets the latest state of a long-running operation. |
list
|
GET /v1/{name=projects/*/locations/*/datasets/*}/operations
Lists operations that match the specified filter in the request. |
REST Resource: v1.projects.locations.services.nlp
Methods | |
---|---|
analyzeEntities
|
POST /v1/{nlpService=projects/*/locations/*/services/nlp}:analyzeEntities
Analyze heathcare entity in a document. |