Method: fhir.vread

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

Gets the contents of a version (current or historical) of a FHIR resource by version ID.

Implements the FHIR standard vread interaction (DSTU2, STU3, R4).

On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store 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.

For samples that show how to call vread, see Retrieving a FHIR resource version.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the resource version 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.