history method

Future<HttpBody> history(String name, { String? P_at, int? P_count, String? P_pageToken, String? P_since, String? $fields, })

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 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. For samples that show how to call history, see Listing FHIR resource versions.

Request parameters:

name - Required. The name of the resource to retrieve. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/datasets/\[^/\]+/fhirStores/\[^/\]+/fhir/\[^/\]+/\[^/\]+$.

P_at - 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

P_count - The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.

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

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

$fields - Selector specifying which fields to include in a partial response.

Completes with a HttpBody.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<HttpBody> history(
  core.String name, {
  core.String? P_at,
  core.int? P_count,
  core.String? P_pageToken,
  core.String? P_since,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (P_at != null) '_at': [P_at],
    if (P_count != null) '_count': ['${P_count}'],
    if (P_pageToken != null) '_page_token': [P_pageToken],
    if (P_since != null) '_since': [P_since],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name') + '/_history';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return HttpBody.fromJson(response_ as core.Map<core.String, core.dynamic>);
}