# Cloud Healthcare API API

> Cloud Healthcare API API on Apizie: 76 endpoints (Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…, Updates the entire contents of a resource. Implements the FHIR standard update interaction…, Update the message. The contents of the message in Message.data and data extracted from the contents such as…, Deletes an HL7v2 message., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/analytics:googleapis-healthcare/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-healthcare`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/healthcare
- Page: https://apizie.tech/api/analytics/googleapis-healthcare
- OpenAPI: https://apizie.tech/api/analytics/googleapis-healthcare/openapi.json

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

## Endpoints

### Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-operations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource. |

### Updates the entire contents of a resource. Implements the FHIR standard update interaction…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-upda` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource to update. |
| body | object | yes | JSON request body |

### Update the message. The contents of the message in Message.data and data extracted from the contents such as…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Output only. Resource name of the Message, of the form… |
| updateMask | string | no | Required. The update mask applies to the resource. For the `FieldMask` definition, see… |
| body | object | yes | JSON request body |

### Deletes an HL7v2 message.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-message-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the HL7v2 message to delete. |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Lists the health datasets in the current project.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | The next_page_token value returned from a previous List request, if any. |
| parent | string | yes | Required. The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`. |

### Creates a new health dataset. Results are returned through the Operation interface which returns either an…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| datasetId | string | no | Required. The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. |
| parent | string | yes | Required. The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`. |
| body | object | yes | JSON request body |

### Creates a new dataset containing de-identified data from the source dataset. The metadata field type is…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-deidentify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceDataset | string | yes | Required. Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. R5 FHIR stores… |
| body | object | yes | JSON request body |

### Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-get-iam` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| options.requestedPolicyVersion | integer | no | Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid… |
| resource | string | yes | REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names)… |

### Sets the access control policy on the specified resource. Replaces any existing policy. Can return…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-set-iam` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names)… |
| body | object | yes | JSON request body |

### Returns permissions that a caller has on the specified resource. If the resource does not exist, this will…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-test-ia` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | REQUIRED: The resource for which the policy detail is being requested. See [Resource… |
| body | object | yes | JSON request body |

### Checks if a particular data_id of a User data mapping in the specified consent store is consented for the…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentStore | string | yes | Required. Name of the consent store where the requested data_id is stored, of the form… |
| body | object | yes | JSON request body |

### Lists the consent stores in the specified dataset.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Restricts the stores returned to those matching a filter. Only filtering on labels is supported. For example,… |
| pageSize | integer | no | Optional. Limit on the number of consent stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | Optional. Token to retrieve the next page of results, or empty to get the first page. |
| parent | string | yes | Required. Name of the dataset. |

### Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentStoreId | string | no | Required. The ID of the consent store to create. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. Cannot be changed… |
| parent | string | yes | Required. The name of the dataset this consent store belongs to. |
| body | object | yes | JSON request body |

### Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-evalua` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentStore | string | yes | Required. Name of the consent store to retrieve User data mappings from. |
| body | object | yes | JSON request body |

### Queries all data_ids that are consented for a specified use in the given consent store and writes them to a…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consentStore | string | yes | Required. Name of the consent store to retrieve User data mappings from. |
| body | object | yes | JSON request body |

### Lists the Attribute definitions in the specified consent store.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-attrib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Restricts the attributes returned to those matching a filter. The only field available for filtering is `category`. For example,… |
| pageSize | integer | no | Optional. Limit on the number of Attribute definitions to return in a single response. If not specified, 100 is used. May not be larger… |
| pageToken | string | no | Optional. Token to retrieve the next page of results or empty to get the first page. |
| parent | string | yes | Required. Name of the consent store to retrieve Attribute definitions from. |

### Creates a new Attribute definition in the parent consent store.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-attrib-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attributeDefinitionId | string | no | Required. The ID of the Attribute definition to create. The string must match the following regex: `_a-zA-Z{0,255}` and must not be a… |
| parent | string | yes | Required. The name of the consent store that this Attribute definition belongs to. |
| body | object | yes | JSON request body |

### Lists the Consent artifacts in the specified consent store.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Restricts the artifacts returned to those matching a filter. The following syntax is available: * A string field value can be… |
| pageSize | integer | no | Optional. Limit on the number of consent artifacts to return in a single response. If not specified, 100 is used. May not be larger than… |
| pageToken | string | no | Optional. The next_page_token value returned from the previous List request, if any. |
| parent | string | yes | Required. Name of the consent store to retrieve consent artifacts from. |

### Creates a new Consent artifact in the parent consent store.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the consent store this Consent artifact belongs to. |
| body | object | yes | JSON request body |

### Activates the latest revision of the specified Consent by committing a new revision with `state` updated to…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Consent to activate, of the form… |
| body | object | yes | JSON request body |

### Lists the Consent in the given consent store, returning each Consent's latest revision.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Restricts the Consents returned to those matching a filter. The following syntax is available: * A string field value can be… |
| pageSize | integer | no | Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | Optional. The next_page_token value returned from the previous List request, if any. |
| parent | string | yes | Required. Name of the consent store to retrieve Consents from. |

### Creates a new Consent in the parent consent store.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-5` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Name of the consent store. |
| body | object | yes | JSON request body |

### Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Consent revision to delete, of the form… |

### Lists the revisions of the specified Consent in reverse chronological order.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-7` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Restricts the revisions returned to those matching a filter. The following syntax is available: * A string field value can be… |
| name | string | yes | Required. The resource name of the Consent to retrieve revisions for. |
| pageSize | integer | no | Optional. Limit on the number of revisions to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | Optional. Token to retrieve the next page of results or empty if there are no more results in the list. |

### Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-8` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Consent to reject, of the form… |
| body | object | yes | JSON request body |

### Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-consen-9` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Consent to revoke, of the form… |
| body | object | yes | JSON request body |

### Archives the specified User data mapping.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-user-d` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the User data mapping to archive. |
| body | object | yes | JSON request body |

### Lists the User data mappings in the specified consent store.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-user-d-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Optional. Restricts the User data mappings returned to those matching a filter. The following syntax is available: * A string field value… |
| pageSize | integer | no | Optional. Limit on the number of User data mappings to return in a single response. If not specified, 100 is used. May not be larger than… |
| pageToken | string | no | Optional. Token to retrieve the next page of results, or empty to get the first page. |
| parent | string | yes | Required. Name of the consent store to retrieve User data mappings from. |

### Creates a new User data mapping in the parent consent store.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-consent-stores-user-d-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Name of the consent store. |
| body | object | yes | JSON request body |

### Lists the DICOM stores in the given dataset.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text… |
| pageSize | integer | no | Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | The next_page_token value returned from the previous List request, if any. |
| parent | string | yes | Required. Name of the dataset. |

### Creates a new DICOM store within the parent dataset.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dicomStoreId | string | no | Required. The ID of the DICOM store that is being created. Any string value up to 256 characters in length. |
| parent | string | yes | Required. The name of the dataset this DICOM store belongs to. |
| body | object | yes | JSON request body |

### De-identifies data from the source store and writes it to the destination store. The metadata field type is…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-deidentif` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceStore | string | yes | Required. Source FHIR store resource name. For example,… |
| body | object | yes | JSON request body |

### Exports the messages to a destination. To filter messages to be exported, define a filter using the start…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the source HL7v2 store, in the format… |
| body | object | yes | JSON request body |

### Gets metrics associated with the DICOM store.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-get-dico` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the DICOM store to get metrics for. |

### Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the target HL7v2 store, in the format… |
| body | object | yes | JSON request body |

### RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-studies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dicomWebPath | string | yes | Required. The path of the RetrieveRenderedFrames DICOMweb request. For example,… |
| parent | string | yes | Required. The name of the DICOM store that is being accessed. For example,… |
| viewport | string | no | Optional. The viewport setting to use as specified in… |

### StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-studies-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dicomWebPath | string | yes | Required. The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional. |
| parent | string | yes | Required. The name of the DICOM store that is being accessed. For example,… |
| body | object | yes | JSON request body |

### DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-studies-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| dicomWebPath | string | yes | Required. The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. |
| parent | string | yes | Required. The name of the DICOM store that is being accessed. For example,… |

### SetBlobStorageSettings sets the blob storage settings of the specified resources.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-dicom-we` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Required. The path of the resource to update the blob storage settings in the format of… |
| body | object | yes | JSON request body |

### GetStudyMetrics returns metrics for a study.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-dicom-we-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| study | string | yes | Required. The study resource path. For example,… |

### GetSeriesMetrics returns metrics for a series.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-dicom-we-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| series | string | yes | Required. The series resource path. For example,… |

### GetStorageInfo returns the storage info of the specified resource.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-dicom-stores-dicom-we-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Required. The path of the instance to return storage info for, in the form:… |

### Applies the admin Consent resources for the FHIR store and reindexes the underlying resources in the FHIR…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-apply-adm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the FHIR store to enforce, in the format… |
| body | object | yes | JSON request body |

### Apply the Consent resources for the FHIR store and reindex the underlying resources in the FHIR store…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-apply-con` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the FHIR store to enforce, in the format… |
| body | object | yes | JSON request body |

### Bulk exports a Group resource and resources in the member field, including related resources for each…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-bulk-expo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| _since | string | no | Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For… |
| _type | string | no | Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. |
| name | string | yes | Required. Name of the Group resource that is exported, in format… |
| organizeOutputBy | string | no | Required. The FHIR resource type used to organize exported resources. Only supports "Patient". When organized by Patient resource, output… |
| outputFormat | string | no | Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported. |

### Bulk deletes the FHIR resources from the given FHIR store. This method returns an Operation that can be used…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-bulk-dele` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the FHIR store to bulk delete resources from, in the format of… |
| body | object | yes | JSON request body |

### Lists the FHIR stores in the given dataset.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text… |
| pageSize | integer | no | Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | The next_page_token value returned from the previous List request, if any. |
| parent | string | yes | Required. Name of the dataset. |

### Creates a new FHIR store within the parent dataset.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fhirStoreId | string | no | Required. The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. |
| parent | string | yes | Required. The name of the dataset this FHIR store belongs to. |
| body | object | yes | JSON request body |

### Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-explain-d` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the FHIR store to enforce, in the format… |
| resourceId | string | no | Required. The ID (`{resourceType}/{id}`) of the resource to explain data access on. |

### Gets metrics associated with the FHIR store.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-get-fhirs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the FHIR store to get metrics for. |

### Rolls back messages from the HL7v2 store to the specified time. This method returns an Operation that can be…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-rollbac` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the HL7v2 store to rollback, in the format of "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}… |
| body | object | yes | JSON request body |

### Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-bina` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the FHIR store this resource belongs to. |
| body | object | yes | JSON request body |

### Returns the consent enforcement status of all consent resources for a patient. On success, the response body…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-pati` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| _count | integer | no | Optional. The maximum number of results on a page. If not specified, 100 is used. May not be larger than 1000. |
| _page_token | string | no | Optional. Used to retrieve the first, previous, next, or last page of consent enforcement statuses when using pagination. Value should be… |
| name | string | yes | Required. The name of the patient to find enforcement statuses, in the format… |

### Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-pati-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| _count | integer | no | Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000. |
| _page_token | string | no | Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or… |
| _since | string | no | Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For… |
| _type | string | no | Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned.… |
| end | string | no | Optional. The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all… |
| name | string | yes | Required. Name of the `Patient` resource for which the information is required. |
| start | string | no | Optional. The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided,… |

### Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-reso` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the resource to purge. |

### Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-reso-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the FHIR store that holds the profiles being used for validation. |
| profile | string | no | Optional. The canonical URL of a profile that this resource should be validated against. For example, to validate a Patient resource… |
| type | string | yes | Required. The FHIR resource type of the resource being validated. For a complete list, see the FHIR Resource Index… |
| body | object | yes | JSON request body |

### Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-bulk` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| _since | string | no | Optional. If provided, only resources updated after this time are exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For… |
| _type | string | no | Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. |
| name | string | yes | Required. The name of the FHIR store to export resources from, in the format… |
| outputFormat | string | no | Optional. Output format of the export. This field is optional and only `application/fhir+ndjson` is supported. |

### Gets the FHIR capability statement ([STU3](https://hl7.org/fhir/STU3/capabilitystatement.html),…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-capa` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. Name of the FHIR store to retrieve the capabilities for. |

### Creates a FHIR resource. Implements the FHIR standard create interaction…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-crea` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the FHIR store this resource belongs to. |
| type | string | yes | Required. The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index… |
| body | object | yes | JSON request body |

### If a resource is found with the identifier specified in the query parameters, updates the entire contents of…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-cond` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the FHIR store this resource belongs to. |
| type | string | yes | Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index… |
| body | object | yes | JSON request body |

### If a resource is found with the identifier specified in the query parameters, updates part of that resource…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-cond-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the FHIR store this resource belongs to. |
| type | string | yes | Required. The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index… |
| body | object | yes | JSON request body |

### Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-cond-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the FHIR store this resource belongs to. |
| type | string | yes | Required. The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index… |

### Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-exec` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Name of the FHIR store in which this bundle will be executed. |
| body | object | yes | JSON request body |

### Lists all the versions of a resource (including the current version and deleted versions) from the FHIR…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-hist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| _at | string | no | Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter… |
| _count | integer | no | The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000. |
| _page_token | string | no | Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of… |
| _since | string | no | Only include resource versions that were created at or after the given instant in time. The instant in time uses the format… |
| name | string | yes | Required. The name of the resource to retrieve. |

### Searches for resources in the given FHIR store according to criteria specified as query parameters.…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-sear` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Name of the FHIR store to retrieve resources from. |
| resourceType | string | no | Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index… |
| body | object | yes | JSON request body |

### Searches for resources in the given FHIR store according to criteria specified as query parameters.…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-fhir-stores-fhir-sear-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Name of the FHIR store to retrieve resources from. |
| resourceType | string | yes | Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index… |
| body | object | yes | JSON request body |

### Lists the HL7v2 stores in the given dataset.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text… |
| pageSize | integer | no | Limit on the number of HL7v2 stores to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | The next_page_token value returned from the previous List request, if any. |
| parent | string | yes | Required. Name of the dataset. |

### Creates a new HL7v2 store within the parent dataset.
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| hl7V2StoreId | string | no | Required. The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. |
| parent | string | yes | Required. The name of the dataset this HL7v2 store belongs to. |
| body | object | yes | JSON request body |

### Gets metrics associated with the HL7v2 store.
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-get-hl7` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the HL7v2 store to get metrics for, in the format… |

### Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-message-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | Restricts messages returned to those matching a filter. The following syntax is available: * A string field value can be written as text… |
| orderBy | string | no | Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order… |
| pageSize | integer | no | Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000. |
| pageToken | string | no | The next_page_token value returned from the previous List request, if any. |
| parent | string | yes | Required. Name of the HL7v2 store to retrieve messages from. |
| view | string | no | Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than… |

### Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-message-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the HL7v2 store this message belongs to. |
| body | object | yes | JSON request body |

### Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-hl7-v2-stores-message-5` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the HL7v2 store this message belongs to. |
| body | object | yes | JSON request body |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |
| body | object | yes | JSON request body |

### Lists operations that match the specified filter in the request. If the server doesn't support this method,…
`GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter | string | no | The standard list filter. |
| name | string | yes | The name of the operation's parent resource. |
| pageSize | integer | no | The standard list page size. |
| pageToken | string | no | The standard list page token. |
| returnPartialSuccess | boolean | no | When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the… |

### Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the…
`POST https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-services-nlp-analyze-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| nlpService | string | yes | The resource name of the service of the form: "projects/{project_id}/locations/{location_id}/services/nlp". |
| body | object | yes | JSON request body |

## Example
```
curl "https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-operations-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Cloud Healthcare API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/analytics:googleapis-healthcare/healthcare-projects-locations-datasets-operations-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Cloud Healthcare API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Cloud Healthcare API itself also needs your own key from googleapis.com.

### Can AI agents use the Cloud Healthcare API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-healthcare.

### What is the status of the Cloud Healthcare API API?
Needs your own provider key (bring your own key)