Google Cloud Healthcare projects API
The projects API from Google Cloud Healthcare — 111 operation(s) for projects.
Google Cloud Healthcare projects API is one of 6 APIs that Google Cloud Healthcare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Project. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 149 operations across 111 paths, and defines 184 schemas. It is described by OpenAPI 3.0.0, at version v1.
Requests are made against a single base URL, https://healthcare.googleapis.com/.
149 operations
111 paths
184 schemas
10 DELETE58 GET4 PATCH73 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Google Cloud Healthcare projects API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (Oauth2) using the implicit flow, exposing 2 scopes.
It supports OAuth 2.0 (Oauth2c) using the authorizationCode flow, exposing 2 scopes.
Oauth2— Oauth 2.0 implicit authenticationOauth2c— Oauth 2.0 authorizationCode authentication
Paths & Operations 149
Across 111 paths, the API surfaces 149 operations — 10 DELETE, 58 GET, 4 PATCH, 73 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
projects 149
POST
/v1/{consentStore}:checkDataAccess
Checks if a particular dataid of a User data mapping in the specified consent store is consented for the specified use.
POST
/v1/{consentStore}:evaluateUserConsents
Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated…
POST
/v1/{consentStore}:queryAccessibleData
Queries all dataids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of…
DELETE
/v1/{name}
Deletes an HL7v2 message.
GET
/v1/{name}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
PATCH
/v1/{name}
Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.createtime cannot be altered. Only the Message.labels field is allowed to be updat…
PUT
/v1/{name}
Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.htmlupdate), [STU3](http://hl7.org/implement/sta…
GET
/v1/{name}/$everything
Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations…
DELETE
/v1/{name}/$purge
Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method…
GET
/v1/{name}/_history
Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http:…
GET
/v1/{name}/fhir/metadata
Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the […
GET
/v1/{name}/locations
Lists information about the supported locations for this service.
GET
/v1/{name}/operations
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
POST
/v1/{name}:activate
Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the specified Consent is in the ACTIVE state, no new revisi…
POST
/v1/{name}:archive
Archives the specified User data mapping.
POST
/v1/{name}:cancel
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it retu…
DELETE
/v1/{name}:deleteRevision
Deletes the specified revision of a Consent. An INVALIDARGUMENT error occurs if the specified revision is the latest revision.
POST
/v1/{name}:export
Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation…
GET
/v1/{name}:getDICOMStoreMetrics
Gets metrics associated with the DICOM store.
GET
/v1/{name}:getFHIRStoreMetrics
Gets metrics associated with the FHIR store.
GET
/v1/{name}:getHL7v2StoreMetrics
Gets metrics associated with the HL7v2 store.
POST
/v1/{name}:import
Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configurat…
GET
/v1/{name}:listRevisions
Lists the revisions of the specified Consent in reverse chronological order.
POST
/v1/{name}:reject
Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified Consent is in the REJECTED state, no new revi…
POST
/v1/{name}:revoke
Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the specified Consent is in the REVOKED state, no new revisi…
POST
/v1/{name}:rollback
Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors a…
POST
/v1/{nlpService}:analyzeEntities
Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities.
GET
/v1/{parent}/attributeDefinitions
Lists the Attribute definitions in the specified consent store.
POST
/v1/{parent}/attributeDefinitions
Creates a new Attribute definition in the parent consent store.
GET
/v1/{parent}/consentArtifacts
Lists the Consent artifacts in the specified consent store.
POST
/v1/{parent}/consentArtifacts
Creates a new Consent artifact in the parent consent store.
GET
/v1/{parent}/consentStores
Lists the consent stores in the specified dataset.
POST
/v1/{parent}/consentStores
Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADYEXISTS error.
GET
/v1/{parent}/consents
Lists the Consent in the given consent store, returning each Consent's latest revision.
POST
/v1/{parent}/consents
Creates a new Consent in the parent consent store.
GET
/v1/{parent}/datasets
Lists the health datasets in the current project.
POST
/v1/{parent}/datasets
Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error. The metadata field type is O…
GET
/v1/{parent}/dicomStores
Lists the DICOM stores in the given dataset.
POST
/v1/{parent}/dicomStores
Creates a new DICOM store within the parent dataset.
DELETE
/v1/{parent}/dicomWeb/{dicomWebPath}
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and s…
GET
/v1/{parent}/dicomWeb/{dicomWebPath}
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema…
POST
/v1/{parent}/dicomWeb/{dicomWebPath}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.htmlsect10.5).…
POST
/v1/{parent}/fhir
Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.htmltransaction), [STU3](https:/…
POST
/v1/{parent}/fhir/_search
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DS…
POST
/v1/{parent}/fhir/{resourceType}/_search
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DS…
DELETE
/v1/{parent}/fhir/{type}
Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional delete interaction, limited to searching by resource identifier. If multiple resources match, 4…
PATCH
/v1/{parent}/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](http://jsonpatch.com/) document. Imp…
POST
/v1/{parent}/fhir/{type}
Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.htmlcreate), [STU3](http://hl7.org/implement/standards/fhir/STU3/h…
PUT
/v1/{parent}/fhir/{type}
If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction, limited to sea…
POST
/v1/{parent}/fhir/{type}/$validate
Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standa…
GET
/v1/{parent}/fhirStores
Lists the FHIR stores in the given dataset.
POST
/v1/{parent}/fhirStores
Creates a new FHIR store within the parent dataset.
GET
/v1/{parent}/hl7V2Stores
Lists the HL7v2 stores in the given dataset.
POST
/v1/{parent}/hl7V2Stores
Creates a new HL7v2 store within the parent dataset.
GET
/v1/{parent}/messages
Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and…
POST
/v1/{parent}/messages
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If a…
POST
/v1/{parent}/messages:ingest
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If a…
GET
/v1/{parent}/userDataMappings
Lists the User data mappings in the specified consent store.
POST
/v1/{parent}/userDataMappings
Creates a new User data mapping in the parent consent store.
GET
/v1/{resource}:getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
POST
/v1/{resource}:setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOTFOUND, INVALIDARGUMENT, and PERMISSIONDENIED errors.
POST
/v1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOTFOUND error. Note: This operation is designed t…
GET
/v1/{series}:getSeriesMetrics
GetSeriesMetrics returns metrics for a series.
POST
/v1/{sourceDataset}:deidentify
Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary.…
POST
/v1/{sourceStore}:deidentify
De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirS…
GET
/v1/{study}:getStudyMetrics
GetStudyMetrics returns metrics for a study.
POST
/v1beta1/{consentStore}:checkDataAccess
Checks if a particular dataid of a User data mapping in the specified consent store is consented for the specified use.
POST
/v1beta1/{consentStore}:evaluateUserConsents
Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated…
POST
/v1beta1/{consentStore}:queryAccessibleData
Queries all dataids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of…
DELETE
/v1beta1/{name}
Deletes an HL7v2 message.
GET
/v1beta1/{name}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
PATCH
/v1beta1/{name}
Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.createtime can't be altered. Only the Message.labels field is allowed to be update…
PUT
/v1beta1/{name}
Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.htmlupdate), [STU3](https://hl7.org/implement/s…
GET
/v1beta1/{name}/$consent-enforcement-status
Returns the consent enforcement status of all consent resources for a patient. On success, the response body contains a JSON-encoded representation of a bundle of Parameters (http://hl7.org/fhir/para…
GET
/v1beta1/{name}/$everything
Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/patient-operation…
DELETE
/v1beta1/{name}/$purge
Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method…
GET
/v1beta1/{name}/$translate
Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate…
GET
/v1beta1/{name}/_history
Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](https…
GET
/v1beta1/{name}/fhir/metadata
Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the…
GET
/v1beta1/{name}/locations
Lists information about the supported locations for this service.
GET
/v1beta1/{name}/operations
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
POST
/v1beta1/{name}:activate
Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the specified Consent is in the ACTIVE state, no new revisi…
POST
/v1beta1/{name}:applyAdminConsents
Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR store according to the aggregate consents. This method also updates the consentconfig.enforce…
POST
/v1beta1/{name}:applyConsents
Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store according to the aggregate consent. The aggregate consent of the patient in scope in this request…
POST
/v1beta1/{name}:archive
Archives the specified User data mapping.
POST
/v1beta1/{name}:cancel
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it retu…
POST
/v1beta1/{name}:configureSearch
Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any…
DELETE
/v1beta1/{name}:deleteRevision
Deletes the specified revision of a Consent. An INVALIDARGUMENT error occurs if the specified revision is the latest revision.
POST
/v1beta1/{name}:evaluate
Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type EvaluateAnnotationStoreResponse, contained in t…
GET
/v1beta1/{name}:explainDataAccess
Explains all the permitted/denied actor, purpose and environment for a given resource.
POST
/v1beta1/{name}:export
Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation…
GET
/v1beta1/{name}:getDICOMStoreMetrics
Gets metrics associated with the DICOM store.
GET
/v1beta1/{name}:getFHIRStoreMetrics
Gets metrics associated with the FHIR store.
GET
/v1beta1/{name}:getHL7v2StoreMetrics
Gets metrics associated with the HL7v2 store.
POST
/v1beta1/{name}:import
Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configurat…
GET
/v1beta1/{name}:listRevisions
Lists the revisions of the specified Consent in reverse chronological order.
POST
/v1beta1/{name}:reject
Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified Consent is in the REJECTED state, no new revi…
POST
/v1beta1/{name}:revoke
Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the specified Consent is in the REVOKED state, no new revisi…
POST
/v1beta1/{name}:rollback
Rolls back resources from the FHIR store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors a…
POST
/v1beta1/{nlpService}:analyzeEntities
Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities. This met…
GET
/v1beta1/{parent}/annotationStores
Lists the Annotation stores in the given dataset for a source store.
POST
/v1beta1/{parent}/annotationStores
Creates a new Annotation store within the parent dataset.
GET
/v1beta1/{parent}/annotations
Lists the Annotations in the given Annotation store for a source resource.
POST
/v1beta1/{parent}/annotations
Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
GET
/v1beta1/{parent}/attributeDefinitions
Lists the Attribute definitions in the specified consent store.
POST
/v1beta1/{parent}/attributeDefinitions
Creates a new Attribute definition in the parent consent store.
GET
/v1beta1/{parent}/consentArtifacts
Lists the Consent artifacts in the specified consent store.
POST
/v1beta1/{parent}/consentArtifacts
Creates a new Consent artifact in the parent consent store.
GET
/v1beta1/{parent}/consentStores
Lists the consent stores in the specified dataset.
POST
/v1beta1/{parent}/consentStores
Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADYEXISTS error.
GET
/v1beta1/{parent}/consents
Lists the Consent in the given consent store, returning each Consent's latest revision.
POST
/v1beta1/{parent}/consents
Creates a new Consent in the parent consent store.
GET
/v1beta1/{parent}/datasets
Lists the health datasets in the current project.
POST
/v1beta1/{parent}/datasets
Creates a new health dataset. Results are returned through the Operation interface which returns either an Operation.response which contains a Dataset or Operation.error. The metadata field type is O…
GET
/v1beta1/{parent}/dicomStores
Lists the DICOM stores in the given dataset.
POST
/v1beta1/{parent}/dicomStores
Creates a new DICOM store within the parent dataset.
DELETE
/v1beta1/{parent}/dicomWeb/{dicomWebPath}
DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and s…
GET
/v1beta1/{parent}/dicomWeb/{dicomWebPath}
RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.…
POST
/v1beta1/{parent}/dicomWeb/{dicomWebPath}
StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.htmlsect10.5). F…
POST
/v1beta1/{parent}/fhir
Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction and history operations. ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.htmltran…
GET
/v1beta1/{parent}/fhir/$references
Lists all the resources that directly refer to the given target FHIR resource. Can also support the case when the target resource doesn't exist, for example, if the target has been deleted. On succes…
GET
/v1beta1/{parent}/fhir/ConceptMap/$translate
Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptm…
GET
/v1beta1/{parent}/fhir/Observation/$lastn
Retrieves the N most recent Observation resources for a subject matching search criteria specified as query parameters, grouped by Observation.code, sorted from most recent to oldest. Implements the…
POST
/v1beta1/{parent}/fhir/_search
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/D…
POST
/v1beta1/{parent}/fhir/{resourceType}/_search
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/implement/standards/fhir/D…
DELETE
/v1beta1/{parent}/fhir/{type}
Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.html2.1.0.12.1), [STU3](http…
PATCH
/v1beta1/{parent}/fhir/{type}
If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) docu…
POST
/v1beta1/{parent}/fhir/{type}
Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](https://hl7.org/implement/standards/fhir/DSTU2/http.htmlcreate), [STU3](https://hl7.org/implement/standards/fhir/STU3…
PUT
/v1beta1/{parent}/fhir/{type}
If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU…
POST
/v1beta1/{parent}/fhir/{type}/$validate
Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate ([DSTU2](http://hl7.org/implement/standa…
GET
/v1beta1/{parent}/fhirStores
Lists the FHIR stores in the given dataset.
POST
/v1beta1/{parent}/fhirStores
Creates a new FHIR store within the parent dataset.
GET
/v1beta1/{parent}/hl7V2Stores
Lists the HL7v2 stores in the given dataset.
POST
/v1beta1/{parent}/hl7V2Stores
Creates a new HL7v2 store within the parent dataset.
GET
/v1beta1/{parent}/messages
Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and…
POST
/v1beta1/{parent}/messages
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If a…
GET
/v1beta1/{parent}/messages:batchGet
Gets multiple messages in the given HL7v2 store.
POST
/v1beta1/{parent}/messages:ingest
Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If a…
GET
/v1beta1/{parent}/userDataMappings
Lists the User data mappings in the specified consent store.
POST
/v1beta1/{parent}/userDataMappings
Creates a new User data mapping in the parent consent store.
GET
/v1beta1/{resource}:getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
GET
/v1beta1/{resource}:getStorageInfo
GetStorageInfo returns the storage info of the specified resource.
POST
/v1beta1/{resource}:setBlobStorageSettings
SetBlobStorageSettings sets the blob storage settings of the specified resources.
POST
/v1beta1/{resource}:setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOTFOUND, INVALIDARGUMENT, and PERMISSIONDENIED errors.
POST
/v1beta1/{resource}:testIamPermissions
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOTFOUND error. Note: This operation is designed t…
GET
/v1beta1/{series}:getSeriesMetrics
GetSeriesMetrics returns metrics for a series.
POST
/v1beta1/{sourceDataset}:deidentify
Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary.…
POST
/v1beta1/{sourceStore}:deidentify
De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirS…
GET
/v1beta1/{study}:getStudyMetrics
GetStudyMetrics returns metrics for a study.
Schemas 184
The contract defines 184 schemas that model the data the API accepts and returns. The most detailed are FhirStore_2 (15 properties), FhirStore (12 properties), Consent (10 properties), Consent_2 (10 properties). Each schema is shown below with its type and property counts.
Dataset
object
A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multi…
2 properties
GcsDestination
object
The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin Cloud IAM roles on the Cloud Storage location.
3 properties
Binding
object
Associates members, or principals, with a role.
3 properties
ReplaceWithInfoTypeConfig
object
When using the INSPECTANDTRANSFORM action, each match is replaced with the name of the infotype. For example, "My name is Jane" becomes "My name is [PERSONNAME…
Consent_2
object
Represents a user's consent.
10 properties
ListUserDataMappingsResponse
object
2 properties
Consent
object
Represents a user's consent.
10 properties
Image
object
Raw bytes representing consent artifact content.
2 properties
Hl7V2StoreMetric
object
Count of messages and total storage size by type for a given HL7 store.
3 properties
ListConsentsResponse
object
2 properties
ListMessagesResponse
object
Lists the messages in the specified HL7v2 store.
2 properties
RejectConsentRequest
object
Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the given Consent i…
1 property
ConsentAccessorScope
object
The accessor scope that describes who can access, for what purpose, in which environment.
3 properties
Vertex
object
A 2D coordinate in an image. The origin is the top-left.
2 properties
Hl7SchemaConfig
object
Root config message for HL7v2 schema. This contains a schema structure of groups and segments, and filters that determine which messages to apply the schema st…
2 properties
Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
SensitiveTextAnnotation
object
A TextAnnotation specifies a text range that includes sensitive information.
1 property
LinkedEntity
object
EntityMentions can be linked to multiple entities using a LinkedEntity message lets us add other fields, e.g. confidence.
1 property
DicomStoreMetrics
object
DicomStoreMetrics contains metrics describing a DICOM store.
6 properties
ResourceAnnotation
object
Resource level annotation.
1 property
DateShiftConfig
object
Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.
2 properties
FhirStore
object
Represents a FHIR store.
12 properties
TextConfig
object
3 properties
Result
object
The consent evaluation result for a single dataid.
3 properties
ListAnnotationsResponse
object
Lists the Annotations in the specified Annotation store.
2 properties
Expr
object
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are docume…
4 properties
ValidationConfig
object
Contains the configuration for FHIR profiles and validation.
5 properties
TimeRange
object
Apply consents given by patients whose most recent consent changes are in the time range. Note that after identifying these patients, the server applies all Co…
2 properties
ApplyAdminConsentsRequest
object
Request to apply the admin Consent resources for the specified FHIR store.
2 properties
DeidentifyDatasetRequest
object
Redacts identifying information from the specified dataset.
3 properties
CancelOperationRequest
object
The request message for Operations.CancelOperation.
GoogleCloudHealthcareV1ConsentPolicy
object
Represents a user's consent in terms of the resources that can be accessed and under what conditions.
2 properties
GoogleCloudHealthcareV1FhirBigQueryDestination
object
The configuration for exporting to BigQuery.
4 properties
ListConsentArtifactsResponse
object
2 properties
GoogleCloudHealthcareV1DicomStreamConfig
object
StreamConfig specifies configuration for a streaming DICOM export.
1 property
FhirNotificationConfig_2
object
Contains the configuration for FHIR notifications.
3 properties
CharacterMaskConfig
object
Mask a string by replacing its characters with a fixed character.
1 property
Segment
object
A segment in a structured format.
3 properties
TextSpan
object
A span of text in the provided document.
2 properties
FilterList
object
List of infoTypes to be filtered.
1 property
ActivateConsentRequest
object
Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. If the latest revision of the given Consent i…
3 properties
FhirStoreMetric
object
Count of resources and total storage size by type for a given FHIR store.
3 properties
SchemaPackage
object
A schema package contains a set of schemas and type definitions.
5 properties
ListOperationsResponse
object
The response message for Operations.ListOperations.
2 properties
ImageConfig
object
Specifies how to handle de-identification of image pixels.
1 property
SchemaGroup
object
An HL7v2 logical group construct.
5 properties
FhirNotificationConfig
object
Contains the configuration for FHIR notifications.
3 properties
Hl7V2NotificationConfig_2
object
Specifies where and whether to send notifications upon changes to a data store.
2 properties
Empty
object
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the resp…
CreateMessageRequest
object
Creates a new message.
1 property
QueryAccessibleDataRequest
object
Queries all dataids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a…
3 properties
GoogleCloudHealthcareV1DicomBigQueryDestination
object
The BigQuery table where the server writes the output.
3 properties
AttributeDefinition
object
A client-defined consent attribute.
6 properties
DicomStore_2
object
Represents a DICOM store.
4 properties
AnalyzeEntitiesRequest
object
The request to analyze healthcare entities in a document.
3 properties
ArchiveUserDataMappingResponse
object
Archives the specified User data mapping.
Signature
object
User signature.
4 properties
AuditConfig
object
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from…
2 properties
BlobStorageSettings
object
Settings for data stored in Blob storage.
1 property
EvaluateUserConsentsRequest
object
Evaluate a user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, causing slight delays between the time map…
7 properties
EntityMention
object
An entity mention in the document.
8 properties
PubsubDestination
object
The Pub/Sub output destination. The Cloud Healthcare Service Agent requires the roles/pubsub.publisher Cloud IAM role on the Pub/Sub topic.
1 property
ListDicomStoresResponse
object
Lists the DICOM stores in the given dataset.
2 properties
StructuredStorageInfo
object
StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.
1 property
SearchResourcesRequest
object
Request to search the resources in the specified FHIR store.
1 property
ApplyConsentsRequest
object
Request to apply the Consent resources for the specified FHIR store.
3 properties
RollbackFhirResourceFilteringFields
object
2 properties
EvaluateAnnotationStoreRequest
object
Request to evaluate an Annotation store against a ground truth [Annotation store].
5 properties
ConsentStore
object
Represents a consent store.
4 properties
Hl7V2Store
object
Represents an HL7v2 store.
5 properties
ImageAnnotation
object
Image annotation.
2 properties
CloudHealthcareSource
object
Cloud Healthcare API resource.
1 property
ListFhirStoresResponse
object
Lists the FHIR stores in the given dataset.
2 properties
StreamConfig_2
object
Contains configuration for streaming FHIR export.
3 properties
InfoTypeConfig
object
Specifies how to use infoTypes for evaluation. For example, a user might only want to evaluate PERSON, LOCATION, and AGE.
3 properties
Attribute_2
object
An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the defau…
2 properties
Hl7V2NotificationConfig
object
Specifies where and whether to send notifications upon changes to a data store.
2 properties
AccessDeterminationLogConfig
object
Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://c…
1 property
TimePartitioning
object
Configuration for FHIR BigQuery time-partitioned tables.
2 properties
FhirStore_2
object
Represents a FHIR store.
15 properties
Attribute
object
An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the defau…
2 properties
ExplainDataAccessResponse
object
List of consent scopes that are applicable to the explained access on a given resource.
2 properties
StreamConfig
object
Contains configuration for streaming FHIR export.
3 properties
Hl7V2StoreMetrics
object
List of metrics for a given HL7v2 store.
2 properties
Annotation
object
An annotation record.
6 properties
DicomFilterConfig
object
Specifies the filter configuration for DICOM resources.
1 property
ParserConfig
object
The configuration for the parser. It determines how the server parses the messages.
4 properties
ExplainDataAccessConsentInfo
object
The enforcing consent's metadata.
7 properties
ExplainDataAccessConsentScope
object
A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent.
4 properties
VersionSource
object
Describes a selector for extracting and matching an MSH field to a value.
2 properties
UserDataMapping
object
Maps a resource to the associated user and Attributes.
6 properties
ConsentEvaluation
object
The detailed evaluation of a particular Consent.
1 property
FieldMetadata
object
Specifies FHIR paths to match, and how to handle de-identification of matching fields.
2 properties
InfoTypeTransformation
object
A transformation to apply to text that is identified as a specific infotype.
6 properties
Message
object
A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.
10 properties
TestIamPermissionsResponse
object
Response message for TestIamPermissions method.
1 property
SetIamPolicyRequest
object
Request message for SetIamPolicy method.
2 properties
ListAttributeDefinitionsResponse
object
2 properties
AnalyzeEntitiesResponse
object
Includes recognized entity mentions and relationships between them.
4 properties
Hl7TypesConfig
object
Root config for HL7v2 datatype definitions for a specific HL7v2 version.
2 properties
GoogleCloudHealthcareV1beta1DicomBigQueryDestination
object
The BigQuery table where the server writes output.
3 properties
Resources
object
A list of FHIR resources.
1 property
CheckDataAccessResponse
object
Checks if a particular dataid of a User data mapping in the given consent store is consented for a given use.
2 properties
ArchiveUserDataMappingRequest
object
Archives the specified User data mapping.
EvaluateUserConsentsResponse
object
2 properties
ParsedData
object
The content of a HL7v2 message in a structured format.
1 property
ConsentList
object
List of resource names of Consent resources.
1 property
PatientId
object
A patient identifier and associated type.
2 properties
AnnotationStore
object
An Annotation store that can store annotation resources such as labels and tags for text, image and audio.
2 properties
Feature
object
A feature of an entity mention.
2 properties
Entity
object
The candidate entities that an entity mention could link to.
3 properties
KmsWrappedCryptoKey
object
Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. The key must grant the Cloud IAM permission cl…
2 properties
BlobStorageInfo
object
BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will…
3 properties
DeidentifyConfig
object
Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type o…
5 properties
AnnotationSource
object
AnnotationSource holds the source information of the annotation.
1 property
GroupOrSegment
object
Construct representing a logical group or a segment.
2 properties
IngestMessageResponse
object
Acknowledges that a message has been ingested into the specified HL7v2 store.
2 properties
GoogleCloudHealthcareV1ConsentGcsDestination
object
The Cloud Storage location for export.
1 property
PatientScope
object
Apply consents given by a list of patients.
1 property
QueryAccessibleDataRequest_2
object
Queries all dataids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a…
3 properties
SeriesMetrics
object
SeriesMetrics contains metrics describing a DICOM series.
4 properties
ConsentArtifact
object
Documentation of a user's consent.
8 properties
GcsSource
object
Specifies the configuration for importing data from Cloud Storage.
1 property
SchemaConfig_2
object
Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.
3 properties
RevokeConsentRequest
object
Revokes the latest revision of the specified Consent by committing a new revision with state updated to REVOKED. If the latest revision of the given Consent is…
1 property
DeidentifyFhirStoreRequest
object
Creates a new FHIR store with sensitive information de-identified.
5 properties
SearchResourcesRequest_2
object
Request to search the resources in the specified FHIR store.
1 property
HttpBody
object
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML pag…
3 properties
GoogleCloudHealthcareV1beta1ConsentGcsDestination
object
The Cloud Storage location for export.
1 property
ListHl7V2StoresResponse
object
Lists the HL7v2 stores in the given dataset.
2 properties
StorageInfo
object
StorageInfo encapsulates all the storage info of a resource.
3 properties
Detail
object
Contains multiple sensitive information findings for each resource slice.
1 property
RollbackFhirResourceFilteringFields_2
object
Filters to select resources that need to be rolled back.
2 properties
DicomConfig
object
Specifies the parameters needed for de-identification of DICOM stores.
4 properties
ListLocationsResponse
object
The response message for Locations.ListLocations.
2 properties
ConfigureSearchRequest
object
Request to configure the search parameters for the specified FHIR store.
2 properties
ConsentConfig
object
Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.
5 properties
ConsentStore_2
object
Represents a consent store.
4 properties
RollbackFhirResourcesRequest_2
object
Request to roll back resources.
8 properties
AdminConsents
object
List of admin Consent resources to be applied.
1 property
CryptoHashConfig
object
Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output (for ex…
2 properties
Policy
object
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding bin…
4 properties
EntityMentionRelationship
object
Defines directed relationship from one entity mention to another.
3 properties
ListAnnotationStoresResponse
object
Lists the Annotation stores in the given dataset.
2 properties
GoogleCloudHealthcareV1beta1ConsentPolicy
object
Represents a user's consent in terms of the resources that can be accessed and under what conditions.
2 properties
GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination
object
The BigQuery table for export.
4 properties
ListDatasetsResponse
object
Lists the available datasets.
2 properties
ListConsentStoresResponse
object
2 properties
SchematizedData
object
The content of an HL7v2 message in a structured format as specified by a schema.
2 properties
ImportMessagesRequest
object
Request to import messages.
1 property
RollbackFhirResourcesRequest
object
8 properties
BoundingPoly
object
A bounding polygon for the detected image annotation.
2 properties
Field
object
A (sub) field of a type.
5 properties
TagFilterList
object
List of tags to be filtered.
1 property
GoogleCloudHealthcareV1beta1FhirBigQueryDestination
object
The configuration for exporting to BigQuery.
4 properties
ValidationConfig_2
object
Contains the configuration for FHIR profiles and validation.
5 properties
ConsentHeaderHandling
object
How the server handles the consent header.
1 property
FhirConfig
object
Specifies how to handle de-identification of a FHIR store.
2 properties
RedactConfig
object
Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jane." becomes "My name is ."
Operation
object
This resource represents a long-running operation that is the result of a network API call.
5 properties
ExportMessagesRequest_2
object
Request to schedule an export.
5 properties
SchemaSegment
object
An HL7v2 Segment.
3 properties
FhirStoreMetrics
object
List of metrics for a given FHIR store.
2 properties
ListConsentRevisionsResponse
object
2 properties
Type
object
A type definition for some HL7v2 type (incl. Segments and Datatypes).
3 properties
FhirFilter
object
Filter configuration.
1 property
SetBlobStorageSettingsRequest
object
Request message for SetBlobStorageSettings method.
2 properties
Finding
object
4 properties
NotificationConfig
object
Specifies where to send notifications upon changes to a data store.
2 properties
BatchGetMessagesResponse
object
Gets multiple messages in a specified HL7v2 store.
1 property
TestIamPermissionsRequest
object
Request message for TestIamPermissions method.
1 property
IngestMessageRequest
object
Ingests a message into the specified HL7v2 store.
1 property
StudyMetrics
object
StudyMetrics contains metrics describing a DICOM study.
5 properties
DeidentifiedStoreDestination
object
Contains configuration for streaming de-identified FHIR export.
2 properties
Hl7V2Store_2
object
Represents an HL7v2 store.
6 properties
SearchParameter
object
Contains the versioned name and the URL for one SearchParameter.
2 properties
CheckDataAccessRequest
object
Checks if a particular dataid of a User data mapping in the given consent store is consented for a given use.
4 properties
SchemaConfig
object
Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.
3 properties
ExportMessagesRequest
object
Request to schedule an export.
5 properties
GoogleCloudHealthcareV1beta1DicomStreamConfig
object
StreamConfig specifies configuration for a streaming DICOM export.
1 property
SearchConfig
object
Contains the configuration for FHIR search.
1 property
DicomStore
object
Represents a DICOM store.
4 properties
Location
object
A resource that represents a Google Cloud location.
5 properties
AuditLogConfig
object
Provides the configuration for logging a type of permissions. Example: { "auditlogconfigs": [ { "logtype": "DATAREAD", "exemptedmembers": [ "user:jose@example.…
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Google Cloud Healthcare 5
Other APIs Google Cloud Healthcare publishes across the network.
Cloud Healthcare FHIR API
Cloud Healthcare HL7v2 API
Cloud Healthcare DICOM API
Cloud Healthcare De-identification API
Cloud Healthcare Consent Management API
#Project
Where this information came from
This is an independent, third-party profile of Google Cloud Healthcare projects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.