Stay organized with collections
Save and categorize content based on your preferences.
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, R5).
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-23 UTC."],[[["\u003cp\u003eThis endpoint retrieves a specific version of a FHIR resource using its version ID, adhering to the FHIR standard's vread interaction across DSTU2, STU3, and R4 versions.\u003c/p\u003e\n"],["\u003cp\u003eThe response body, upon success, will contain a JSON-encoded representation of the requested FHIR resource, while errors will return a JSON-encoded \u003ccode\u003eOperationOutcome\u003c/code\u003e resource or a general GCP error.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a GET method, and requires a specific URL format following gRPC Transcoding syntax, with the resource version name specified in the path.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to access this endpoint requires the \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permission on the specified resource and one of the OAuth scopes \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this endpoint is empty.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.vread\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.vread\n\nGets the contents of a version (current or historical) of a FHIR resource by version ID.\n\nImplements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.org/fhir/R5/http.html#vread)).\n\nOn 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.\n\nFor samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*/_history/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
