Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.fhir.read
Gets the contents of a FHIR resource.
Implements the FHIR standard read interaction (DSTU2, STU3, R4), R5).
Also supports the FHIR standard conditional read interaction (DSTU2, STU3, R4), R5) 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 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 API method, \u003ccode\u003eprojects.locations.datasets.fhirStores.fhir.read\u003c/code\u003e, retrieves the contents of a FHIR resource.\u003c/p\u003e\n"],["\u003cp\u003eIt supports the FHIR standard read interaction across DSTU2, STU3, and R4 versions, as well as the conditional read interaction by using \u003ccode\u003eIf-Modified-Since\u003c/code\u003e or \u003ccode\u003eIf-None-Match\u003c/code\u003e headers.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns a JSON-encoded representation of the resource, while errors from the FHIR store are reported as a JSON-encoded \u003ccode\u003eOperationOutcome\u003c/code\u003e resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permission on the specified resource name.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGET\u003c/code\u003e request URL structure uses the \u003ccode\u003egRPC Transcoding\u003c/code\u003e syntax and requires either \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: fhir.read\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.read\n\nGets the contents of a FHIR resource.\n\nImplements the FHIR standard read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#read), [STU3](https://hl7.org/fhir/STU3/http.html#read), [R4](https://hl7.org/fhir/R4/http.html#read)), [R5](https://hl7.org/fhir/R5/http.html#read)).\n\nAlso supports the FHIR standard conditional read interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#cread), [STU3](https://hl7.org/fhir/STU3/http.html#cread), [R4](https://hl7.org/fhir/R4/http.html#cread)), [R5](https://hl7.org/fhir/R5/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value.\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 `read`, see [Getting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).\n\n### HTTP request\n\n`GET https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}`\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)."]]
