Cloud Healthcare API

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

Service: healthcare.googleapis.com

All URIs below are relative to https://healthcare.googleapis.com

This service provides the following discovery documents:

REST Resource: v1alpha2.projects.locations

Methods
get GET /v1alpha2/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1alpha2/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1alpha2.projects.locations.datasets

Methods
create POST /v1alpha2/{parent=projects/*/locations/*}/datasets
Creates a new health dataset.
deidentify POST /v1alpha2/{sourceDataset=projects/*/locations/*/datasets/*}:deidentify
Creates a new dataset containing de-identified data from the source dataset.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*}
Deletes the specified health dataset and all data contained in the dataset.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*}
Gets any metadata associated with a dataset.
getIamPolicy GET /v1alpha2/{resource=projects/*/locations/*/datasets/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1alpha2/{parent=projects/*/locations/*}/datasets
Lists the health datasets in the current project.
patch PATCH /v1alpha2/{dataset.name=projects/*/locations/*/datasets/*}
Updates dataset metadata.
setIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1alpha2/{resource=projects/*/locations/*/datasets/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1alpha2.projects.locations.datasets.annotationStores

Methods
create POST /v1alpha2/{parent=projects/*/locations/*/datasets/*}/annotationStores
Creates a new Annotation store within the parent dataset.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/annotationStores/*}
Deletes the specified Annotation store and removes all annotations that are contained within it.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/annotationStores/*}
Gets the specified Annotation store or returns NOT_FOUND if it does not exist.
getIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/annotationStores/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1alpha2/{parent=projects/*/locations/*/datasets/*}/annotationStores
Lists the Annotation stores in the given dataset for a source store.
patch PATCH /v1alpha2/{annotationStore.name=projects/*/locations/*/datasets/*/annotationStores/*}
Updates the specified Annotation store.
setIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/annotationStores/*}:setIamPolicy
POLICIES Sets the access control policy for a resource.
testIamPermissions POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/annotationStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1alpha2.projects.locations.datasets.annotationStores.annotations

Methods
create POST /v1alpha2/{parent=projects/*/locations/*/datasets/*/annotationStores/*}/annotations
Creates a new Annotation record.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/annotationStores/*/annotations/*}
Deletes an Annotation or returns NOT_FOUND if it does not exist.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/annotationStores/*/annotations/*}
Gets an Annotation.
list GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/annotationStores/*}/annotations
Lists the Annotations in the given Annotation store for a source resource.
patch PATCH /v1alpha2/{annotation.name=projects/*/locations/*/datasets/*/annotationStores/*/annotations/*}
Updates the Annotation.

REST Resource: v1alpha2.projects.locations.datasets.dicomStores

Methods
create POST /v1alpha2/{parent=projects/*/locations/*/datasets/*}/dicomStores
Creates a new DICOM store within the parent dataset.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/dicomStores/*}
Deletes the specified DICOM store and removes all images that are contained within it.
export POST /v1alpha2/{name=projects/*/locations/*/datasets/*/dicomStores/*}:export
Exports data to the specified destination by copying it from the DICOM store.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/dicomStores/*}
Gets the specified DICOM store.
getIamPolicy GET /v1alpha2/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:getIamPolicy
Gets the access control policy for a resource.
import POST /v1alpha2/{name=projects/*/locations/*/datasets/*/dicomStores/*}:import
Imports data into the DICOM store by copying it from the specified source.
list GET /v1alpha2/{parent=projects/*/locations/*/datasets/*}/dicomStores
Lists the DICOM stores in the given dataset.
patch PATCH /v1alpha2/{dicomStore.name=projects/*/locations/*/datasets/*/dicomStores/*}
Updates the specified DICOM store.
setIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/dicomStores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1alpha2.projects.locations.datasets.dicomStores.dicomWeb

Methods
searchForInstances GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath}
SearchForInstances returns a list of matching instances.
searchForSeries GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath}
SearchForSeries returns a list of matching series.
searchForStudies GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath}
SearchForStudies returns a list of matching studies.
storeInstances POST /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).

REST Resource: v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies

Methods
delete DELETE /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
DeleteStudy deletes all instances within the given study.
metadata GET /v1alpha2/{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 /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
RetrieveStudy returns all instances within the given study.
searchForInstances GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/instances}
SearchForInstances returns a list of matching instances.
searchForSeries GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series}
SearchForSeries returns a list of matching series.
storeInstances POST /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID).

REST Resource: v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series

Methods
delete DELETE /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}
DeleteSeries deletes all instances within the given study and series.
metadata GET /v1alpha2/{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 /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*}
RetrieveSeries returns all instances within the given study and series.
searchForInstances GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances}
SearchForInstances returns a list of matching instances.

REST Resource: v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances

Methods
delete DELETE /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID.
metadata GET /v1alpha2/{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.
rendered GET /v1alpha2/{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.
retrieveInstance GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}
RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID.

REST Resource: v1alpha2.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.frames

Methods
rendered GET /v1alpha2/{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.
retrieveFrames GET /v1alpha2/{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.

REST Resource: v1alpha2.projects.locations.datasets.fhirStores

Methods
capabilities GET /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*}/metadata
Gets the FHIR capability statement for the store, which contains a description of functionality supported by the server.
create POST /v1alpha2/{parent=projects/*/locations/*/datasets/*}/fhirStores
Creates a new FHIR store within the parent dataset.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Deletes the specified FHIR store and removes all resources within it.
export POST /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export
Export resources from the FHIR store to the specified destination.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Gets the configuration of the specified FHIR store.
getIamPolicy GET /v1alpha2/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:getIamPolicy
Gets the access control policy for a FHIR store or security label within a FHIR store.
import POST /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*}:import
Import resources to the FHIR store by loading data from the specified sources.
list GET /v1alpha2/{parent=projects/*/locations/*/datasets/*}/fhirStores
Lists the FHIR stores in the given dataset.
patch PATCH /v1alpha2/{fhirStore.name=projects/*/locations/*/datasets/*/fhirStores/*}
Updates the configuration of the specified FHIR store.
setIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/fhirStores/*}:setIamPolicy
Sets the access control policy for a FHIR store or security label within a FHIR store.
testIamPermissions POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/fhirStores/**}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1alpha2.projects.locations.datasets.fhirStores.fhir

Methods
Observation-lastn GET /v1alpha2/{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-everything GET /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everything
Retrieves all the resources in the patient compartment for a Patient resource.
Resource-purge DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/$purge
Deletes all the historical versions of a resource (excluding the current version) from the FHIR store.
capabilities GET /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/metadata
Gets the FHIR capability statement for the store, which contains a description of functionality supported by the server.
conditionalDelete DELETE /v1alpha2/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
Deletes FHIR resources that match a search query.
conditionalPatch PATCH /v1alpha2/{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 /v1alpha2/{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 /v1alpha2/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{type}
Creates a FHIR resource.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Deletes a FHIR resource.
executeBundle POST /v1alpha2/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir
Executes all the requests in the given Bundle.
history GET /v1alpha2/{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 /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Updates part of an existing resource by applying the operations specified in a JSON Patch document.
read GET /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Gets the contents of a FHIR resource.
search GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/{resourceType=**}
Searches for resources in the given FHIR store according to criteria specified as query parameters.
update PUT /v1alpha2/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}
Updates the entire contents of a resource.
vread GET /v1alpha2/{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: v1alpha2.projects.locations.datasets.fhirStores.securityLabels

Methods
getIamPolicy GET /v1alpha2/{resource=projects/*/locations/*/datasets/*/fhirStores/*/securityLabels/*}:getIamPolicy
Gets the access control policy for a FHIR store or security label within a FHIR store.
setIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/fhirStores/*/securityLabels/*}:setIamPolicy
Sets the access control policy for a FHIR store or security label within a FHIR store.

REST Resource: v1alpha2.projects.locations.datasets.hl7V2Stores

Methods
create POST /v1alpha2/{parent=projects/*/locations/*/datasets/*}/hl7V2Stores
Creates a new HL7v2 store within the parent dataset.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Deletes the specified HL7v2 store and removes all messages that are contained within it.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Gets the specified HL7v2 store.
getIamPolicy GET /v1alpha2/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1alpha2/{parent=projects/*/locations/*/datasets/*}/hl7V2Stores
Lists the HL7v2 stores in the given dataset.
patch PATCH /v1alpha2/{hl7V2Store.name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Updates the HL7v2 store.
setIamPolicy POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1alpha2/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1alpha2.projects.locations.datasets.hl7V2Stores.messages

Methods
create POST /v1alpha2/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages
Creates a message and sends a notification to the Cloud Pub/Sub topic.
delete DELETE /v1alpha2/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}
Deletes an HL7v2 message.
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}
Gets an HL7v2 message.
ingest POST /v1alpha2/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages:ingest
Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic.
list GET /v1alpha2/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages
Lists all the messages in the given HL7v2 store with support for filtering.
patch PATCH /v1alpha2/{message.name=projects/*/locations/*/datasets/*/hl7V2Stores/*/messages/*}
Update the message.

REST Resource: v1alpha2.projects.locations.datasets.operations

Methods
get GET /v1alpha2/{name=projects/*/locations/*/datasets/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1alpha2/{name=projects/*/locations/*/datasets/*}/operations
Lists operations that match the specified filter in the request.

We recommend that you call this service using Google-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may 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.dicomStores

Methods
create POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/dicomStores
Creates a new DICOM store within the parent dataset.
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.
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}
SearchForInstances returns a list of matching instances.
searchForSeries GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath}
SearchForSeries returns a list of matching series.
searchForStudies GET /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath}
SearchForStudies returns a list of matching studies.
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}
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.studies

Methods
delete DELETE /v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*}
DeleteStudy deletes all instances within the given study.
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.
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.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
create POST /v1beta1/{parent=projects/*/locations/*/datasets/*}/fhirStores
Creates a new FHIR store within the parent dataset.
delete DELETE /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Deletes the specified FHIR store and removes all resources within it.
export POST /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}:export
Export resources from the FHIR store to the specified destination.
get GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}
Gets the configuration of the specified 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.
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.
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
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-everything GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/Patient/*}/$everything
Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment.
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.
capabilities GET /v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*}/fhir/metadata
Gets the FHIR capability statement 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.
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.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 are contained within it.
get GET /v1beta1/{name=projects/*/locations/*/datasets/*/hl7V2Stores/*}
Gets the specified HL7v2 store.
getIamPolicy GET /v1beta1/{resource=projects/*/locations/*/datasets/*/hl7V2Stores/*}:getIamPolicy
Gets the access control policy for a resource.
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.
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.hl7V2Stores.messages

Methods
create POST /v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages
Creates a message and sends a notification to the Cloud Pub/Sub topic.
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:ingest
Ingests a new HL7v2 message from the hospital and sends a notification to the Cloud Pub/Sub topic.
list GET /v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages
Lists 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
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.
Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Cloud Healthcare API