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/*}/locationsLists information about the supported locations for this service. | 
REST Resource: v1beta1.projects.locations.datasets
| Methods | |
|---|---|
| create | POST /v1beta1/{parent=projects/*/locations/*}/datasetsCreates a new health dataset. | 
| deidentify | POST /v1beta1/{sourceDataset=projects/*/locations/*/datasets/*}:deidentifyCreates 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/*}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent=projects/*/locations/*}/datasetsLists 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/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource=projects/*/locations/*/datasets/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.datasets.consentStores
| Methods | |
|---|---|
| checkDataAccess | POST /v1beta1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:checkDataAccessChecks if a particular data_id of a User data mappingin the specifiedconsent storeis consented for the specified use. | 
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/consentStoresCreates a new consent storein the parent dataset. | 
| delete | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*}Deletes the specified consent storeand removes all the consent store's data. | 
| evaluateUserConsents | POST /v1beta1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:evaluateUserConsentsEvaluates the user's Consentsfor all matchingUser data mappings. | 
| get | GET /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*}Gets the specified consent store. | 
| getIamPolicy | GET /v1beta1/{resource=projects/*/locations/*/datasets/*/consentStores/*}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/consentStoresLists the consent storesin the specified dataset. | 
| patch | PATCH /v1beta1/{consentStore.name=projects/*/locations/*/datasets/*/consentStores/*}Updates the specified consent store. | 
| queryAccessibleData | POST /v1beta1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:queryAccessibleDataQueries all data_ids that are consented for a specified use in the given consent storeand writes them to a specified destination. | 
| setIamPolicy | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/consentStores/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/consentStores/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.datasets.consentStores.attributeDefinitions
| Methods | |
|---|---|
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/attributeDefinitionsCreates a new Attribute definitionin the parentconsent store. | 
| delete | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/attributeDefinitions/*}Deletes the specified Attribute definition. | 
| get | GET /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/attributeDefinitions/*}Gets the specified Attribute definition. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/attributeDefinitionsLists the Attribute definitionsin the specifiedconsent store. | 
| patch | PATCH /v1beta1/{attributeDefinition.name=projects/*/locations/*/datasets/*/consentStores/*/attributeDefinitions/*}Updates the specified Attribute definition. | 
REST Resource: v1beta1.projects.locations.datasets.consentStores.consentArtifacts
| Methods | |
|---|---|
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentArtifactsCreates a new Consent artifactin the parentconsent store. | 
| delete | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consentArtifacts/*}Deletes the specified Consent artifact. | 
| get | GET /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consentArtifacts/*}Gets the specified Consent artifact. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentArtifactsLists the Consent artifactsin the specifiedconsent store. | 
REST Resource: v1beta1.projects.locations.datasets.consentStores.consents
| Methods | |
|---|---|
| activate | POST /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:activateActivates the latest revision of the specified Consentby committing a new revision withstateupdated toACTIVE. | 
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentsCreates a new Consentin the parentconsent store. | 
| delete | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}Deletes the Consentand its revisions. | 
| deleteRevision | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:deleteRevisionDeletes the specified revision of a Consent. | 
| get | GET /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}Gets the specified revision of a Consent, or the latest revision ifrevision_idis not specified in the resource name. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentsLists the Consentin the givenconsent store, returning each Consent's latest revision. | 
| listRevisions | GET /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:listRevisionsLists the revisions of the specified Consentin reverse chronological order. | 
| patch | PATCH /v1beta1/{consent.name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}Updates the latest revision of the specified Consentby committing a new revision with the changes. | 
| reject | POST /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:rejectRejects the latest revision of the specified Consentby committing a new revision withstateupdated toREJECTED. | 
| revoke | POST /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:revokeRevokes the latest revision of the specified Consentby committing a new revision withstateupdated toREVOKED. | 
REST Resource: v1beta1.projects.locations.datasets.consentStores.userDataMappings
| Methods | |
|---|---|
| archive | POST /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}:archiveArchives the specified User data mapping. | 
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/userDataMappingsCreates a new User data mappingin the parentconsent store. | 
| delete | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}Deletes the specified User data mapping. | 
| get | GET /v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}Gets the specified User data mapping. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/userDataMappingsLists the User data mappingsin the specifiedconsent store. | 
| patch | PATCH /v1beta1/{userDataMapping.name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}Updates the specified User data mapping. | 
REST Resource: v1beta1.projects.locations.datasets.dataMapperWorkspaces
| Methods | |
|---|---|
| getIamPolicy | GET /v1beta1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:getIamPolicyGets the access control policy for a resource. | 
| setIamPolicy | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.datasets.dicomStores
| Methods | |
|---|---|
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/dicomStoresCreates a new DICOM store within the parent dataset. | 
| deidentify | POST /v1beta1/{sourceStore=projects/*/locations/*/datasets/*/dicomStores/*}:deidentifyDe-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/*}:exportExports 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/*}:getDICOMStoreMetricsGets metrics associated with the DICOM store. | 
| getIamPolicy | GET /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:getIamPolicyGets the access control policy for a resource. | 
| import | POST /v1beta1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:importImports data into the DICOM store by copying it from the specified source. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/dicomStoresLists 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/*}:setBlobStorageSettingsSetBlobStorageSettings sets the blob storage settings of the specified resources. | 
| setIamPolicy | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setIamPolicySets 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/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
| updateInstances | PUT /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies}UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID). | 
REST Resource: v1beta1.projects.locations.datasets.dicomStores.dicomWeb.studies
| Methods | |
|---|---|
| getStudyMetrics | GET /v1beta1/{study=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/*}:getStudyMetricsGetStudyMetrics returns metrics for a study. | 
| setBlobStorageSettings | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/**}:setBlobStorageSettingsSetBlobStorageSettings 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/*}:getSeriesMetricsGetSeriesMetrics 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/*}:getStorageInfoGetStorageInfo 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. | 
| 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). | 
| updateInstances | PUT /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}UpdateInstances updates DICOM instances associated with study instance unique identifiers (SUID). | 
| updateMetadata | PATCH /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}/metadataUpdateStudyMetadata modifies the metadata of all instances in the given study. | 
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. | 
| 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. | 
| updateMetadata | PATCH /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}/metadataUpdateSeriesMetadata modifies the metadata of all instances in the given series. | 
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. | 
| 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. | 
| updateMetadata | PATCH /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}/metadataUpdateInstanceMetadata modifies the metadata of a single instance. | 
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/*}:applyAdminConsentsApplies 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/*}:applyConsentsApply 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/*}/$exportBulk 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/*}:configureSearchConfigure 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/*}/fhirStoresCreates a new FHIR store within the parent dataset. | 
| deidentify | POST /v1beta1/{sourceStore=projects/*/locations/*/datasets/*/fhirStores/*}:deidentifyDe-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/*}:explainDataAccessExplains all the permitted/denied actor, purpose and environment for a given resource. | 
| export | POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:exportExport resources from the FHIR store to the specified destination. | 
| exportHistory | POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:exportHistoryExport 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/*}:getFHIRStoreMetricsGets metrics associated with the FHIR store. | 
| getIamPolicy | GET /v1beta1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:getIamPolicyGets the access control policy for a resource. | 
| import | POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:importImport resources to the FHIR store by loading data from the specified sources. | 
| importHistory | POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:importHistoryImport resource historical versions from Cloud Storage source to destination fhir store. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/fhirStoresLists 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/*}:rollbackRolls back resources from the FHIR store to the specified time. | 
| setIamPolicy | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:testIamPermissionsReturns 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/BinaryCreates 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/$translateTranslates 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/*}/$translateTranslates 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-statusReturns the consent enforcement status of a single consent resource. | 
| Encounter-everything | GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Encounter/*}/$everythingRetrieves an Encounter resource and resources related to that Encounter. | 
| Observation-lastn | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/Observation/$lastnRetrieves the N most recent Observationresources for a subject matching search criteria specified as query parameters, grouped byObservation.code, sorted from most recent to oldest. | 
| Patient-consent-enforcement-status | GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$consent-enforcement-statusReturns the consent enforcement status of all consent resources for a patient. | 
| Patient-everything | GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everythingRetrieves a Patient resource and resources related to that patient. | 
| Resource-incoming-references | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/$referencesLists all the resources that directly refer to the given target FHIR resource. | 
| Resource-purge | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/$purgeDeletes 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}/$validateValidates 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/$exportBulk exports all resources from the FHIR store to the specified destination. | 
| capabilities | GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/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 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/*}/fhirExecutes all the requests in the given Bundle. | 
| history | GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/_historyLists 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}/_searchSearches 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/*}/hl7V2StoresCreates 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/*}:exportExports 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/*}:getHL7v2StoreMetricsGets metrics associated with the HL7v2 store. | 
| getIamPolicy | GET /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getIamPolicyGets the access control policy for a resource. | 
| import | POST /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:importImport messages to the HL7v2 store by loading data from the specified sources. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*}/hl7V2StoresLists 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/*}:rollbackRolls back messages from the HL7v2 store to the specified time. | 
| setIamPolicy | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1beta1.projects.locations.datasets.hl7V2Stores.messages
| Methods | |
|---|---|
| batchGet | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages:batchGetGets multiple messages in the given HL7v2 store. | 
| create | POST /v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messagesParses and stores an HL7v2 message. | 
| delete | DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}Deletes an HL7v2 message. | 
| get | GET /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}Gets an HL7v2 message. | 
| ingest | POST /v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages:ingestParses and stores an HL7v2 message. | 
| list | GET /v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messagesLists all the messages in the given HL7v2 store with support for filtering. | 
| patch | PATCH /v1beta1/{message.name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}Update the message. | 
REST Resource: v1beta1.projects.locations.datasets.operations
| Methods | |
|---|---|
| cancel | POST /v1beta1/{name=projects/*/locations/*/datasets/*/operations/*}:cancelStarts 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/*}/operationsLists 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}:analyzeEntitiesAnalyze 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/*}/locationsLists information about the supported locations for this service. | 
REST Resource: v1.projects.locations.datasets
| Methods | |
|---|---|
| create | POST /v1/{parent=projects/*/locations/*}/datasetsCreates a new health dataset. | 
| deidentify | POST /v1/{sourceDataset=projects/*/locations/*/datasets/*}:deidentifyCreates 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/*}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent=projects/*/locations/*}/datasetsLists 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/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource=projects/*/locations/*/datasets/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.datasets.consentStores
| Methods | |
|---|---|
| checkDataAccess | POST /v1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:checkDataAccessChecks if a particular data_id of a User data mappingin the specifiedconsent storeis consented for the specified use. | 
| create | POST /v1/{parent=projects/*/locations/*/datasets/*}/consentStoresCreates a new consent storein the parent dataset. | 
| delete | DELETE /v1/{name=projects/*/locations/*/datasets/*/consentStores/*}Deletes the specified consent storeand removes all the consent store's data. | 
| evaluateUserConsents | POST /v1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:evaluateUserConsentsEvaluates the user's Consentsfor all matchingUser data mappings. | 
| get | GET /v1/{name=projects/*/locations/*/datasets/*/consentStores/*}Gets the specified consent store. | 
| getIamPolicy | GET /v1/{resource=projects/*/locations/*/datasets/*/consentStores/*}:getIamPolicyGets the access control policy for a resource. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*}/consentStoresLists the consent storesin the specified dataset. | 
| patch | PATCH /v1/{consentStore.name=projects/*/locations/*/datasets/*/consentStores/*}Updates the specified consent store. | 
| queryAccessibleData | POST /v1/{consentStore=projects/*/locations/*/datasets/*/consentStores/*}:queryAccessibleDataQueries all data_ids that are consented for a specified use in the given consent storeand writes them to a specified destination. | 
| setIamPolicy | POST /v1/{resource=projects/*/locations/*/datasets/*/consentStores/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource=projects/*/locations/*/datasets/*/consentStores/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.datasets.consentStores.attributeDefinitions
| Methods | |
|---|---|
| create | POST /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/attributeDefinitionsCreates a new Attribute definitionin the parentconsent store. | 
| delete | DELETE /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/attributeDefinitions/*}Deletes the specified Attribute definition. | 
| get | GET /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/attributeDefinitions/*}Gets the specified Attribute definition. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/attributeDefinitionsLists the Attribute definitionsin the specifiedconsent store. | 
| patch | PATCH /v1/{attributeDefinition.name=projects/*/locations/*/datasets/*/consentStores/*/attributeDefinitions/*}Updates the specified Attribute definition. | 
REST Resource: v1.projects.locations.datasets.consentStores.consentArtifacts
| Methods | |
|---|---|
| create | POST /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentArtifactsCreates a new Consent artifactin the parentconsent store. | 
| delete | DELETE /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consentArtifacts/*}Deletes the specified Consent artifact. | 
| get | GET /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consentArtifacts/*}Gets the specified Consent artifact. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentArtifactsLists the Consent artifactsin the specifiedconsent store. | 
REST Resource: v1.projects.locations.datasets.consentStores.consents
| Methods | |
|---|---|
| activate | POST /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:activateActivates the latest revision of the specified Consentby committing a new revision withstateupdated toACTIVE. | 
| create | POST /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentsCreates a new Consentin the parentconsent store. | 
| delete | DELETE /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}Deletes the Consentand its revisions. | 
| deleteRevision | DELETE /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:deleteRevisionDeletes the specified revision of a Consent. | 
| get | GET /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}Gets the specified revision of a Consent, or the latest revision ifrevision_idis not specified in the resource name. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consentsLists the Consentin the givenconsent store, returning each Consent's latest revision. | 
| listRevisions | GET /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:listRevisionsLists the revisions of the specified Consentin reverse chronological order. | 
| patch | PATCH /v1/{consent.name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}Updates the latest revision of the specified Consentby committing a new revision with the changes. | 
| reject | POST /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:rejectRejects the latest revision of the specified Consentby committing a new revision withstateupdated toREJECTED. | 
| revoke | POST /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:revokeRevokes the latest revision of the specified Consentby committing a new revision withstateupdated toREVOKED. | 
REST Resource: v1.projects.locations.datasets.consentStores.userDataMappings
| Methods | |
|---|---|
| archive | POST /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}:archiveArchives the specified User data mapping. | 
| create | POST /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/userDataMappingsCreates a new User data mappingin the parentconsent store. | 
| delete | DELETE /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}Deletes the specified User data mapping. | 
| get | GET /v1/{name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}Gets the specified User data mapping. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/userDataMappingsLists the User data mappingsin the specifiedconsent store. | 
| patch | PATCH /v1/{userDataMapping.name=projects/*/locations/*/datasets/*/consentStores/*/userDataMappings/*}Updates the specified User data mapping. | 
REST Resource: v1.projects.locations.datasets.dataMapperWorkspaces
| Methods | |
|---|---|
| getIamPolicy | GET /v1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:getIamPolicyGets the access control policy for a resource. | 
| setIamPolicy | POST /v1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource=projects/*/locations/*/datasets/*/dataMapperWorkspaces/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.datasets.dicomStores
| Methods | |
|---|---|
| create | POST /v1/{parent=projects/*/locations/*/datasets/*}/dicomStoresCreates a new DICOM store within the parent dataset. | 
| deidentify | POST /v1/{sourceStore=projects/*/locations/*/datasets/*/dicomStores/*}:deidentifyDe-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/*}:exportExports 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/*}:getDICOMStoreMetricsGets metrics associated with the DICOM store. | 
| getIamPolicy | GET /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:getIamPolicyGets the access control policy for a resource. | 
| import | POST /v1/{name=projects/*/locations/*/datasets/*/dicomStores/*}:importImports data into the DICOM store by copying it from the specified source. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*}/dicomStoresLists 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/*}:setBlobStorageSettingsSetBlobStorageSettings sets the blob storage settings of the specified resources. | 
| setIamPolicy | POST /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setIamPolicySets 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/*}:testIamPermissionsReturns 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/*}:getStudyMetricsGetStudyMetrics returns metrics for a study. | 
| setBlobStorageSettings | POST /v1/{resource=projects/*/locations/*/datasets/*/dicomStores/*/dicomWeb/studies/**}:setBlobStorageSettingsSetBlobStorageSettings 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/*}:getSeriesMetricsGetSeriesMetrics 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/*}:getStorageInfoGetStorageInfo 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. | 
| 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. | 
| 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. | 
| 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/*}:applyAdminConsentsApplies 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/*}:applyConsentsApply 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/*}/$exportBulk exports a Group resource and resources in the member field, including related resources for each Patient member. | 
| create | POST /v1/{parent=projects/*/locations/*/datasets/*}/fhirStoresCreates a new FHIR store within the parent dataset. | 
| deidentify | POST /v1/{sourceStore=projects/*/locations/*/datasets/*/fhirStores/*}:deidentifyDe-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/*}:explainDataAccessExplains all the permitted/denied actor, purpose and environment for a given resource. | 
| export | POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:exportExport 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/*}:getFHIRStoreMetricsGets metrics associated with the FHIR store. | 
| getIamPolicy | GET /v1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:getIamPolicyGets the access control policy for a resource. | 
| import | POST /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:importImports resources to the FHIR store by loading data from the specified sources. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*}/fhirStoresLists 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/*}:rollbackRolls back resources from the FHIR store to the specified time. | 
| setIamPolicy | POST /v1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:testIamPermissionsReturns 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/BinaryCreates 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-statusReturns the consent enforcement status of a single consent resource. | 
| Patient-consent-enforcement-status | GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$consent-enforcement-statusReturns the consent enforcement status of all consent resources for a patient. | 
| Patient-everything | GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everythingRetrieves a Patient resource and resources related to that patient. | 
| Resource-purge | DELETE /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/$purgeDeletes 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}/$validateValidates 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/$exportBulk exports all resources from the FHIR store to the specified destination. | 
| capabilities | GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/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 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/*}/fhirExecutes all the requests in the given Bundle. | 
| history | GET /v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/_historyLists 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}/_searchSearches 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/*}/hl7V2StoresCreates 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/*}:exportExports 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/*}:getHL7v2StoreMetricsGets metrics associated with the HL7v2 store. | 
| getIamPolicy | GET /v1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getIamPolicyGets the access control policy for a resource. | 
| import | POST /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}:importImport messages to the HL7v2 store by loading data from the specified sources. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*}/hl7V2StoresLists 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/*}:rollbackRolls back messages from the HL7v2 store to the specified time. | 
| setIamPolicy | POST /v1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:setIamPolicySets the access control policy on the specified resource. | 
| testIamPermissions | POST /v1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:testIamPermissionsReturns permissions that a caller has on the specified resource. | 
REST Resource: v1.projects.locations.datasets.hl7V2Stores.messages
| Methods | |
|---|---|
| create | POST /v1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messagesParses and stores an HL7v2 message. | 
| delete | DELETE /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}Deletes an HL7v2 message. | 
| get | GET /v1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}Gets an HL7v2 message. | 
| ingest | POST /v1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages:ingestParses and stores an HL7v2 message. | 
| list | GET /v1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messagesLists all the messages in the given HL7v2 store with support for filtering. | 
| patch | PATCH /v1/{message.name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}Update the message. | 
REST Resource: v1.projects.locations.datasets.operations
| Methods | |
|---|---|
| cancel | POST /v1/{name=projects/*/locations/*/datasets/*/operations/*}:cancelStarts 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/*}/operationsLists 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}:analyzeEntitiesAnalyze heathcare entity in a document. |