getFhirOperationStatus method

Future<HttpBody> getFhirOperationStatus(
  1. String name, {
  2. String? $fields,
})

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.

Request parameters:

name - Required. Name of the operation to query, in the format projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{operation_id}. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+/fhirStores/\[^/\]+/operations/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a HttpBody.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<HttpBody> getFhirOperationStatus(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return HttpBody.fromJson(response_ as core.Map<core.String, core.dynamic>);
}