healthcare.projects.locations.datasets.fhir Stores.fhir.history
GET {{baseUrl}}/v1/:name/_history?_at=<string>&_count=<integer>&_page_token=<string>&_since=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
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. For samples that show how to call history
, see Listing FHIR resource versions.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
_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 | |
_count | string | The maximum number of search results on a page. Defaults to 1000. | |
_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. | |
_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. | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"contentType":"\u003cstring\u003e","data":"\u003cbyte\u003e","extensions":["\u003cobject\u003e","\u003cobject\u003e"]}