Documentation

Google_Service_CloudHealthcare_Resource_ProjectsLocationsDatasetsFhirStores extends Google_Service_Resource
in package

Application

The "fhirStores" collection of methods.

Typical usage is: $healthcareService = new Google_Service_CloudHealthcare(...); $fhirStores = $healthcareService->fhirStores;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_CloudHealthcare_FhirStore: Creates a new FHIR store within the parent dataset. (fhirStores.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
deidentify() : Google_Service_CloudHealthcare_Operation: 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 DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). (fhirStores.deidentify)
delete() : Google_Service_CloudHealthcare_HealthcareEmpty: Deletes the specified FHIR store and removes all resources within it.
export() : Google_Service_CloudHealthcare_Operation: Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. (fhirStores.export)
get() : Google_Service_CloudHealthcare_FhirStore: Gets the configuration of the specified FHIR store. (fhirStores.get)
getIamPolicy() : Google_Service_CloudHealthcare_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (fhirStores.getIamPolicy)
import() : Google_Service_CloudHealthcare_Operation: Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store.
listProjectsLocationsDatasetsFhirStores() : Google_Service_CloudHealthcare_ListFhirStoresResponse: Lists the FHIR stores in the given dataset.
patch() : Google_Service_CloudHealthcare_FhirStore: Updates the configuration of the specified FHIR store. (fhirStores.patch)
setIamPolicy() : Google_Service_CloudHealthcare_Policy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (fhirStores.setIamPolicy)
testIamPermissions() : Google_Service_CloudHealthcare_TestIamPermissionsResponse: 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 `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Creates a new FHIR store within the parent dataset. (fhirStores.create)


    public
                create(string $parent, Google_Service_CloudHealthcare_FhirStore $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_FhirStore

Parameters

$parent : string: The name of the dataset this FHIR store belongs to.
$postBody : Google_Service_CloudHealthcare_FhirStore
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_FhirStore —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

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 DeidentifyFhirStoreSummary. If errors occur, error is set. Error details are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). (fhirStores.deidentify)


    public
                deidentify(string $sourceStore, Google_Service_CloudHealthcare_DeidentifyFhirStoreRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

Parameters

$sourceStore : string: Source FHIR store resource name. For example, pro jects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{ fhir_store_id}.
$postBody : Google_Service_CloudHealthcare_DeidentifyFhirStoreRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

delete()

Deletes the specified FHIR store and removes all resources within it.


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_HealthcareEmpty

(fhirStores.delete)

Parameters

$name : string: The resource name of the FHIR store to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_HealthcareEmpty —

export()

Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing logs](/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. (fhirStores.export)


    public
                export(string $name, Google_Service_CloudHealthcare_ExportResourcesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

Parameters

$name : string: The name of the FHIR store to export resource from, in the format of projects/{project_id}/locations/{location_id}/datasets/{datase t_id}/fhirStores/{fhir_store_id}.
$postBody : Google_Service_CloudHealthcare_ExportResourcesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

get()

Gets the configuration of the specified FHIR store. (fhirStores.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_FhirStore

Parameters

$name : string: The resource name of the FHIR store to get.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_FhirStore —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (fhirStores.getIamPolicy)


    public
                getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Policy —

import()

Imports resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store.


    public
                import(string $name, Google_Service_CloudHealthcare_ImportResourcesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Operation

This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it's possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the BUNDLE format. When using the BUNDLE format this method ignores the Bundle.type field, except that history bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in Bundle.entry.resource, ignoring Bundle.entry.request. As an example, this allows the import of searchset bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing logs). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. (fhirStores.import)

Parameters

$name : string: The name of the FHIR store to import FHIR resources to, in the format of projects/{project_id}/locations/{location_id}/datasets/{dat aset_id}/fhirStores/{fhir_store_id}.
$postBody : Google_Service_CloudHealthcare_ImportResourcesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Operation —

listProjectsLocationsDatasetsFhirStores()

Lists the FHIR stores in the given dataset.


    public
                listProjectsLocationsDatasetsFhirStores(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_ListFhirStoresResponse

(fhirStores.listProjectsLocationsDatasetsFhirStores)

Parameters

$parent : string: Name of the dataset.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_ListFhirStoresResponse —

patch()

Updates the configuration of the specified FHIR store. (fhirStores.patch)


    public
                patch(string $name, Google_Service_CloudHealthcare_FhirStore $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_FhirStore

Parameters

$name : string: Output only. Resource name of the FHIR store, of the form projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
$postBody : Google_Service_CloudHealthcare_FhirStore
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_FhirStore —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. (fhirStores.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_CloudHealthcare_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudHealthcare_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_Policy —

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 `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.


    public
                testIamPermissions(string $resource, Google_Service_CloudHealthcare_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudHealthcare_TestIamPermissionsResponse

This operation may "fail open" without warning. (fhirStores.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_CloudHealthcare_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudHealthcare_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —