fhir_operation_status
Creates, updates, deletes, gets or lists a fhir_operation_status
resource.
Overview
Name | fhir_operation_status |
Type | Resource |
Id | google.healthcare.fhir_operation_status |
Fields
The following fields are returned by SELECT
queries:
- get-fhir-operation-status
Successful response
Name | Datatype | Description |
---|---|---|
contentType | string | The HTTP Content-Type header value specifying the content type of the body. |
data | string (byte) | The HTTP request/response body as raw binary. |
extensions | array | Application specific response metadata. Must be set in the first response for streaming APIs. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get-fhir-operation-status | select | projectsId , locationsId , datasetsId , fhirStoresId , operationsId | 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. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
datasetsId | string | |
fhirStoresId | string | |
locationsId | string | |
operationsId | string | |
projectsId | string |
SELECT
examples
- 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.
SELECT
contentType,
data,
extensions
FROM google.healthcare.fhir_operation_status
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND fhirStoresId = '{{ fhirStoresId }}' -- required
AND operationsId = '{{ operationsId }}' -- required;