2026-01-13
▼ ▲ discoveryengine.projects.locations.dataStores.addPatientFilter
Parameters :
dataStore
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
Path : v1alpha/{+dataStore}:addPatientFilter
Parameter Order : dataStore
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:addPatientFilter
Description : Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
HTTP Method : POST
Scopes :
▼ ▲ discoveryengine.projects.locations.dataStores.removePatientFilter
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:removePatientFilter
Scopes :
Description : Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.
HTTP Method : POST
Parameters :
dataStore
Location : path
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Type : string
Required : Yes
Path : v1alpha/{+dataStore}:removePatientFilter
Parameter Order : dataStore
▼ ▲ discoveryengine.projects.locations.dataStores.replacePatientFilter
Scopes :
Description : Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
Path : v1alpha/{+dataStore}:replacePatientFilter
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:replacePatientFilter
Parameter Order : dataStore
HTTP Method : POST
Parameters :
dataStore
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Type : string
Required : Yes
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
Location : path
▼ ▲ discoveryengine.projects.locations.dataStores.deletePatientFilter
HTTP Method : POST
Scopes :
Parameters :
dataStore
Type : string
Location : path
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Parameter Order : dataStore
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:deletePatientFilter
Description : Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.
Path : v1alpha/{+dataStore}:deletePatientFilter
▼ ▲ discoveryengine.projects.locations.collections.dataStores.addPatientFilter
Description : Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
HTTP Method : POST
Path : v1alpha/{+dataStore}:addPatientFilter
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:addPatientFilter
Scopes :
Parameter Order : dataStore
Parameters :
dataStore
Required : Yes
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Type : string
▼ ▲ discoveryengine.projects.locations.collections.dataStores.deletePatientFilter
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:deletePatientFilter
Parameters :
dataStore
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
Location : path
Required : Yes
Type : string
Description : Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.
Parameter Order : dataStore
HTTP Method : POST
Path : v1alpha/{+dataStore}:deletePatientFilter
Scopes :
▼ ▲ discoveryengine.projects.locations.collections.dataStores.replacePatientFilter
HTTP Method : POST
Scopes :
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:replacePatientFilter
Path : v1alpha/{+dataStore}:replacePatientFilter
Parameters :
dataStore
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Type : string
Parameter Order : dataStore
Description : Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.removePatientFilter
Parameter Order : dataStore
Path : v1alpha/{+dataStore}:removePatientFilter
Description : Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:removePatientFilter
Scopes :
Parameters :
dataStore
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$
Location : path
Description : Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned
Type : string
Required : Yes
HTTP Method : POST