Namespace Google.Apis.CloudHealthcare.v1

Classes

CloudHealthcareBaseServiceRequest<TResponse>

A base abstract class for CloudHealthcare requests.

CloudHealthcareService.Scope

Available OAuth 2.0 scopes for use with the Cloud Healthcare API.

CloudHealthcareService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Healthcare API.

ProjectsResource.LocationsResource

The "locations" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource

The "datasets" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource

The "consentStores" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource

The "attributeDefinitions" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource.CreateRequest

Creates a new Attribute definition in the parent consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource.DeleteRequest

Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource.GetRequest

Gets the specified Attribute definition.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource.ListRequest

Lists the Attribute definitions in the specified consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.AttributeDefinitionsResource.Request

Updates the specified Attribute definition.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.CheckDataAccessRequest

Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource

The "consentArtifacts" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource.CreateRequest

Creates a new Consent artifact in the parent consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource.DeleteRequest

Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource.GetRequest

Gets the specified Consent artifact.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentArtifactsResource.ListRequest

Lists the Consent artifacts in the specified consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource

The "consents" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ActivateRequest

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 revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.CreateRequest

Creates a new Consent in the parent consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.DeleteRequest

Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.DeleteRevisionRequest

Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.GetRequest

Gets the specified revision of a Consent, or the latest revision if revision_id is not specified in the resource name.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ListRequest

Lists the Consent in the given consent store, returning each Consent's latest revision.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.ListRevisionsRequest

Lists the revisions of the specified Consent in reverse chronological order.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.Request

Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the REJECTED or REVOKED state.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.RejectRequest

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 revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the ACTIVE or REVOKED state.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ConsentsResource.RevokeRequest

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 revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in DRAFT or REJECTED state.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.CreateRequest

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 ALREADY_EXISTS error.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.DeleteRequest

Deletes the specified consent store and removes all the consent store's data.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.EvaluateUserConsentsRequest

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 and when they are included in EvaluateUserConsents results.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.GetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.GetRequest

Gets the specified consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.ListRequest

Lists the consent stores in the specified dataset.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.Request

Updates the specified consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.QueryAccessibleDataRequest

Queries all data_ids 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 User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). For example, the following sample log entry shows a failed to evaluate consent policy error that occurred during a QueryAccessibleData call to consent store projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}.

json jsonPayload: { @type:
"type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code:
9 message: "failed to evaluate consent policy" } resourceName:
"projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}"
} logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data"
operation: { id:
"projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}"
producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP"
resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}"
location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" }
severity: "ERROR" timestamp: "TIMESTAMP"

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.SetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.TestIamPermissionsRequest

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. This operation may "fail open" without warning.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource

The "userDataMappings" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource.ArchiveRequest

Archives the specified User data mapping.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource.CreateRequest

Creates a new User data mapping in the parent consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource.DeleteRequest

Deletes the specified User data mapping.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource.GetRequest

Gets the specified User data mapping.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource.ListRequest

Lists the User data mappings in the specified consent store.

ProjectsResource.LocationsResource.DatasetsResource.ConsentStoresResource.UserDataMappingsResource.Request

Updates the specified User data mapping.

ProjectsResource.LocationsResource.DatasetsResource.CreateRequest

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 OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.DataMapperWorkspacesResource

The "dataMapperWorkspaces" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DataMapperWorkspacesResource.GetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.DataMapperWorkspacesResource.SetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.DataMapperWorkspacesResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.DatasetsResource.DeidentifyRequest

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. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The new de-identified dataset will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging.

ProjectsResource.LocationsResource.DatasetsResource.DeleteRequest

Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource

The "dicomStores" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.CreateRequest

Creates a new DICOM store within the parent dataset.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DeidentifyRequest

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 DeidentifyDicomStoreSummary. If errors occur, error is set. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. Failed resource totals are tracked in Operation.metadata. Error details are also logged to Cloud Logging (see Viewing error logs in Cloud Logging).

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DeleteRequest

Deletes the specified DICOM store and removes all images that are contained within it.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource

The "dicomWeb" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource

The "studies" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource.GetStudyMetricsRequest

GetStudyMetrics returns metrics for a study.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource.SeriesResource

The "series" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource.SeriesResource.GetSeriesMetricsRequest

GetSeriesMetrics returns metrics for a series.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource.SeriesResource.InstancesResource

The "instances" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource.SeriesResource.InstancesResource.GetStorageInfoRequest

GetStorageInfo returns the storage info of the specified resource.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.DicomWebResource.StudiesResource.SetBlobStorageSettingsRequest

SetBlobStorageSettings sets the blob storage settings of the specified resources.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ExportRequest

Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetDICOMStoreMetricsRequest

Gets metrics associated with the DICOM store.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.GetRequest

Gets the specified DICOM store.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ImportRequest

Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. The metadata field type is OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.ListRequest

Lists the DICOM stores in the given dataset.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.Request

Updates the specified DICOM store.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForInstancesRequest

SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Search for DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForSeriesRequest

SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Search for DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SearchForStudiesRequest

SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see Search transaction in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Search for DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SetBlobStorageSettingsRequest

SetBlobStorageSettings sets the blob storage settings of the specified resources.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.SetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StoreInstancesRequest

StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Store DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource

The "studies" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.DeleteRequest

DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see Delete a study, series, or instance.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveMetadataRequest

RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieve metadata.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.RetrieveStudyRequest

RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieve DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForInstancesRequest

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SearchForSeriesRequest

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource

The "series" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.DeleteRequest

DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Delete a study, series, or instance.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource

The "instances" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.DeleteRequest

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 series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Delete a study, series, or instance.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.FramesResource

The "frames" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.FramesResource.RetrieveFramesRequest

RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see DICOM frames in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieve DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.FramesResource.RetrieveRenderedRequest

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.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieve consumer image formats.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveInstanceRequest

RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see DICOM study/series/instances and DICOM instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieve an instance.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveMetadataRequest

RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieve metadata.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.InstancesResource.RetrieveRenderedRequest

RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see Rendered resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieve consumer image formats.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.RetrieveMetadataRequest

RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see Metadata resources in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieve metadata.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.RetrieveSeriesRequest

RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see DICOM study/series/instances in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieve DICOM data.

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.SeriesResource.SearchForInstancesRequest

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.StudiesResource.StoreInstancesRequest

ProjectsResource.LocationsResource.DatasetsResource.DicomStoresResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource

The "fhirStores" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ApplyAdminConsentsRequest

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 consent_config.enforced_admin_consents field of the FhirStore unless validate_only=true in ApplyAdminConsentsRequest. Any admin Consent resource change after this operation execution (including deletion) requires you to call ApplyAdminConsents again for the change to take effect. This method returns an Operation that can be used to track the progress of the resources that were reindexed, by calling GetOperation. Upon completion, the ApplyAdminConsentsResponse additionally contains the number of resources that were reindexed. If at least one Consent resource contains an error or fails be be enforced for any reason, the method returns an error instead of an Operation. No resources will be reindexed and the consent_config.enforced_admin_consents field will be unchanged. To enforce a consent check for data access, consent_config.access_enforced must be set to true for the FhirStore.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ApplyConsentsRequest

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 replaces any previous call of this method. Any Consent resource change after this operation execution (including deletion) requires you to call ApplyConsents again to have effect. This method returns an Operation that can be used to track the progress of the consent resources that were processed by calling GetOperation. Upon completion, the ApplyConsentsResponse additionally contains the number of resources that was reindexed. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). To enforce consent check for data access, consent_config.access_enforced must be set to true for the FhirStore.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.BulkExportGroupRequest

Bulk exports a Group resource and resources in the member field, including related resources for each Patient member. The export for each Patient is identical to a GetPatientEverything request. Implements the FHIR implementation guide $export group of patients. The following headers must be set in the request: * Accept: specifies the format of the OperationOutcome response. Only application/fhir+json is supported. * Prefer: specifies whether the response is immediate or asynchronous. Must be to respond-async because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * _type: string of comma-delimited FHIR resource types. If provided, only resources of the specified type(s) are exported. * _since: if provided, only resources updated after the specified time are exported. * _outputFormat: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. * organizeOutputBy: resource type to organize the output by. Required and must be set to Patient. When specified, output files are organized by instances of the specified resource type, including the resource, referenced resources, and resources that contain references to that resource. On success, the Content-Location header of response is set to a URL that you can use to query the status of the export. The URL is in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.CreateRequest

Creates a new FHIR store within the parent dataset.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeidentifyRequest

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 error logs in Cloud Logging).

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.DeleteRequest

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

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExplainDataAccessRequest

Explains all the permitted/denied actor, purpose and environment for a given resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ExportRequest

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 error logs in Cloud 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.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource

The "fhir" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryCreateRequest

Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as fhir.create. If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the content field (DSTU2 and STU3), or the data field (R4). The Binary resource's contentType will be filled in using the value of the Content-Type header, and the securityContext field (not present in DSTU2) will be populated from the X-Security-Context header if it exists. At this time securityContext has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 1 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as exporting to BigQuery or Pub/Sub notifications with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's data field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is unsupported. On success, an empty 201 Created response is returned. The newly created resource's ID and version are returned in the Location header. Using Prefer: representation=resource is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryReadRequest

Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's contentType field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryUpdateRequest

Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as update. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the content field (DSTU2 and STU3), or the data field (R4). The Binary resource's contentType will be filled in using the value of the Content-Type header, and the securityContext field (not present in DSTU2) will be populated from the X-Security-Context header if it exists. At this time securityContext has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as exporting to BigQuery or Pub/Sub notifications with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's data field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is unsupported. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using Prefer: representation=resource is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BinaryVreadRequest

Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's contentType field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.BulkExportRequest

Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * Accept: specifies the format of the OperationOutcome response. Only application/fhir+json is supported. * Prefer: specifies whether the response is immediate or asynchronous. Must be to respond-async because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * _type: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * _since: if provided, only the resources that are updated after the specified time are exported. * _outputFormat: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the Content-Location header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CapabilitiesRequest

Gets the FHIR capability statement (STU3, R4), or the conformance statement in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3, R4), or the conformance interaction in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a CapabilityStatement resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalDeleteRequest

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, 412 Precondition Failed error will be returned. Search term for identifier should be in the pattern identifier=system|value or identifier=value - similar to the search method on resources with a specific identifier. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resource is moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call conditionalDelete, see Conditionally deleting a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalRequest

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 document. Implements the FHIR standard conditional interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern identifier=system|value or identifier=value - similar to the search method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a 412 Precondition Failed error. The request body must contain a JSON document, and the request headers must contain Content-Type: application/json-+json. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call conditional, see Conditionally ing a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConditionalUpdateRequest

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 searching by resource identifier. Search term for identifier should be in the pattern identifier=system|value or identifier=value - similar to the search method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a 412 Precondition Failed error. If the search criteria identify zero matches, and the supplied resource body contains an id, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an id, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call conditionalUpdate, see Conditionally updating a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ConsentEnforcementStatusRequest

Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a Parameters (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.CreateRequest

Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2, STU3, R4), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction (DSTU2, STU3, R4), specified by supplying an If-None-Exist header containing a FHIR search query, limited to searching by resource identifier. If no resources match this search query, the server processes the create operation as normal. When using conditional create, the search term for identifier should be in the pattern identifier=system|value or identifier=value - similar to the search method on resources with a specific identifier. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call create, see Creating a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.DeleteRequest

Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2, STU3, R4). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call delete, see Deleting a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ExecuteBundleRequest

Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2, STU3, R4). Supports all interactions within a bundle, except search. This method accepts Bundles of type batch and transaction, processing them according to the batch processing rules (DSTU2, STU3, R4) and transaction processing rules (DSTU2, STU3, R4). The request body must contain a JSON-encoded FHIR Bundle resource, and the request headers must contain Content-Type: application/fhir+json. For a batch bundle or a successful transaction, the response body contains a JSON-encoded representation of a Bundle resource of type batch-response or transaction-response containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method checks permissions for each request in the bundle. The executeBundle permission is required to call this method, but you must also grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a request to create a FHIR resource, the caller must also have been granted the healthcare.fhirResources.create permission. You can use audit logs to view the permissions for executeBundle and each request in the bundle. For more information, see Viewing Cloud Audit logs. For samples that show how to call executeBundle, see Managing FHIR resources using FHIR bundles.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.HistoryRequest

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, STU3, R4). On success, the response body contains a JSON-encoded representation of a Bundle resource of type history, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call history, see Listing FHIR resource versions.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.Request

Updates part of an existing resource by applying the operations specified in a JSON document. Implements the FHIR standard interaction (STU3, R4). DSTU2 doesn't define a method, but the server supports it in the same way it supports STU3. The request body must contain a JSON document, and the request headers must contain Content-Type: application/json-+json. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call , see ing a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatientConsentEnforcementStatusRequest

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/parameters.html) FHIR resources, containing the current enforcement status for each consent resource of the patient. Does not support DSTU2.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatientEverythingRequest

Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition (DSTU2, STU3, R4), which details the eligible resource types and referencing search parameters. For samples that show how to call Patient-everything, see Getting all patient compartment resources.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ReadRequest

Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2, STU3, R4). Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4) specified by supplying an If-Modified-Since header with a date/time value or an If-None-Match header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call read, see Getting a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourcePurgeRequest

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. This is not a FHIR standard operation. For samples that show how to call Resource-purge, see Deleting historical versions of a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.ResourceValidateRequest

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, STU3, or R4). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The Parameters input syntax is not supported. The profile query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchRequest

Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2, STU3, R4) using the search semantics described in the FHIR Search specification (DSTU2, STU3, R4). Supports four methods of search defined by the specification: * GET [base]?[parameters] to search across all resources. * GET [base]/[type]?[parameters] to search resources of a specified type. * POST [base]/_search?[parameters] as an alternate form having the same semantics as the GET method across all resources. * POST [base]/[type]/_search?[parameters] as an alternate form having the same semantics as the GET method for the specified type. The GET and POST methods do not support compartment searches. The POST method does not support application/x-www-form-urlencoded search parameters. On success, the response body contains a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3, R4). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: :missing, :exact, :contains, :text, :in, :not-in, :above, :below, :[type], :not, and recurse (DSTU2 and STU3) or :iterate (R4). Supported search result parameters: _sort, _count, _include, _revinclude, _summary=text, _summary=data, and _elements. The maximum number of search results returned defaults to 100, which can be overridden by the _count parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned Bundle contains a link of relation "next", which has a _page_token parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern identifier=[system]|[value] or identifier=[value], and any of the following search result parameters can be used: * _count * _include * _revinclude * _summary * _elements If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional _sort parameter in your query. Use _sort=-_lastUpdated if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see Searching for FHIR resources and Advanced FHIR search features.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.SearchTypeRequest

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.UpdateRequest

Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2, STU3, R4). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain Content-Type: application/fhir+json. The resource must contain an id element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call update, see Updating a FHIR resource.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.VreadRequest

Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded OperationOutcome resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call vread, see Retrieving a FHIR resource version.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetFHIRStoreMetricsRequest

Gets metrics associated with the FHIR store.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.GetRequest

Gets the configuration of the specified FHIR store.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ImportRequest

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. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. 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 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 error logs in Cloud Logging). 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.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.ListRequest

Lists the FHIR stores in the given dataset.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.OperationsResource.DeleteFhirOperationRequest

Deletes operations as defined in the FHIR specification. Implements the FHIR implementation guide bulk data delete request. Returns success if the operation was successfully cancelled. If the operation is complete, or has already been cancelled, returns an error response.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.OperationsResource.GetFhirOperationStatusRequest

Gets the status of operations as defined in the FHIR specification. Implements the FHIR implementation guide bulk data status request. Operations can have one of these states: * in-progress: response status code is 202 and X-Progress header is set to in progress. * complete: response status code is 200 and the body is a JSON-encoded operation response as defined by the spec. For a bulk export, this response is defined in https://build.fhir.org/ig/HL7/bulk-data/export.html#response---complete-status. * error: response status code is 5XX, and the body is a JSON-encoded OperationOutcome resource describing the reason for the error.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.Request

Updates the configuration of the specified FHIR store.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.RollbackRequest

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 appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type RollbackFhirResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.SetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.DatasetsResource.GetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.GetRequest

Gets any metadata associated with a dataset.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource

The "hl7V2Stores" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.CreateRequest

Creates a new HL7v2 store within the parent dataset.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.DeleteRequest

Deletes the specified HL7v2 store and removes all messages that it contains.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ExportRequest

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 that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetHL7v2StoreMetricsRequest

Gets metrics associated with the HL7v2 store.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.GetRequest

Gets the specified HL7v2 store.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ImportRequest

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 configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. 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 error logs in Cloud Logging). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.ListRequest

Lists the HL7v2 stores in the given dataset.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource

The "messages" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.CreateRequest

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.DeleteRequest

Deletes an HL7v2 message.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.GetRequest

Gets an HL7v2 message.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.IngestRequest

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 an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (ACK) message. If the method encounters an error, it returns a negative acknowledgment (NACK) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest

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 when it can be found through a filter.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.Request

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.Request

Updates the HL7v2 store.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.RollbackRequest

Rolls back messages from the HL7v2 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 appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.SetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.DatasetsResource.ListRequest

Lists the health datasets in the current project.

ProjectsResource.LocationsResource.DatasetsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.CancelRequest

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 returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.GetRequest

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.

ProjectsResource.LocationsResource.DatasetsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

ProjectsResource.LocationsResource.DatasetsResource.Request

Updates dataset metadata.

ProjectsResource.LocationsResource.DatasetsResource.SetIamPolicyRequest

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

ProjectsResource.LocationsResource.DatasetsResource.TestIamPermissionsRequest

ProjectsResource.LocationsResource.GetRequest

Gets information about a location.

ProjectsResource.LocationsResource.ListRequest

Lists information about the supported locations for this service.

ProjectsResource.LocationsResource.ServicesResource

The "services" collection of methods.

ProjectsResource.LocationsResource.ServicesResource.NlpResource

The "nlp" collection of methods.

ProjectsResource.LocationsResource.ServicesResource.NlpResource.AnalyzeEntitiesRequest

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.

Enums

CloudHealthcareBaseServiceRequest<TResponse>.AltEnum

Data format for response.

CloudHealthcareBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.GetRequest.ViewEnum

Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.

ProjectsResource.LocationsResource.DatasetsResource.Hl7V2StoresResource.MessagesResource.ListRequest.ViewEnum

Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a page_size larger than the default can generate a large response, which impacts the performance of this method.