Method: fhir.history

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).

On success, the response body will contain 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 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/v1beta1/{name=projects/*/locations/*/datasets/*/fhirStores/*/fhir/*/*}/_history

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The name of the resource to retrieve.

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. Defaults to 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
pageToken

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.

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.