Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.fhirStores.fhir.history
Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store.
Implements the per-resource form of the FHIR standard history interaction (DSTU2, STU3, R4, R5).
On success, the response body contains a JSON-encoded representation of a Bundle resource of type history, containing the version history sorted from most recent to oldest versions. 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.
Authorization requires the following IAM permission on the specified resource name:
healthcare.fhirResources.get
Query parameters
Parameters
_count
integer
The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.
_since
string
Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone.
_at
string
Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm]
Clients may specify any of the following:
An entire year: _at=2019
An entire month: _at=2019-01
A specific day: _at=2019-01-20
A specific second: _at=2018-12-31T23:59:58Z
_page_token
string
Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of _page_token set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where link.relation is "previous" or "next".
Omit _page_token if no previous request has been made.
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.
[[["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, \u003ccode\u003eprojects.locations.datasets.fhirStores.fhir.history\u003c/code\u003e, retrieves all versions of a specified FHIR resource, including both current and deleted versions.\u003c/p\u003e\n"],["\u003cp\u003eThe response is a JSON-encoded \u003ccode\u003eBundle\u003c/code\u003e resource of type \u003ccode\u003ehistory\u003c/code\u003e, containing the version history in descending order from most recent to oldest.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003ehealthcare.fhirResources.get\u003c/code\u003e IAM permission, and can utilize query parameters such as \u003ccode\u003e_count\u003c/code\u003e, \u003ccode\u003e_since\u003c/code\u003e, \u003ccode\u003e_at\u003c/code\u003e, and \u003ccode\u003e_page_token\u003c/code\u003e to filter or paginate the version history.\u003c/p\u003e\n"],["\u003cp\u003eThe request should be a \u003ccode\u003eGET\u003c/code\u003e request with an empty body, and the resource name must be provided as a path parameter within the URL.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this endpoint requires one of the specified 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"]]],[],null,["# Method: fhir.history\n\n**Full name**: projects.locations.datasets.fhirStores.fhir.history\n\nLists all the versions of a resource (including the current version and deleted versions) from the FHIR store.\n\nImplements the per-resource form of the FHIR standard history interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#history), [STU3](https://hl7.org/fhir/STU3/http.html#history), [R4](https://hl7.org/fhir/R4/http.html#history), [R5](https://hl7.org/fhir/R5/http.html#history)).\n\nOn success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. 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 `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).\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### Query 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)."]]
