Method: fhir.read

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

Gets the contents of a FHIR resource.

Implements the FHIR standard read interaction.

Also supports the FHIR standard conditional read interaction 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 will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will 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.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the resource to retrieve.

Authorization requires the following Google 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.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Healthcare API