Method: fhir.Binary-read

Full name: projects.locations.datasets.fhirStores.fhir.Binary-read

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.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Binary resource to retrieve.

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

  • healthcare.fhirResources.get

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.