Method: operations.get-fhir-operation-status

Full name: projects.locations.datasets.fhirStores.operations.get-fhir-operation-status

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.

HTTP request

GET https://healthcare.googleapis.com/v1/{name=projects/*/locations/*/datasets/*/fhirStores/*/operations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the operation to query, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/fhirStores/{fhirStoreId}/operations/{operation_id}.

Authorization requires the following IAM permission on the specified resource name:

  • healthcare.fhirStores.getFhirOperationStatus

Request body

The request body must be empty.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-healthcare
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.