Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.HistoryRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<HttpBody>
CloudHealthcareBaseServiceRequest<HttpBody>
ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.HistoryRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.HistoryRequest : CloudHealthcareBaseServiceRequest<HttpBody>, IClientServiceRequest<HttpBody>, IClientServiceRequest

Constructors

HistoryRequest(IClientService, string)

Constructs a new History request.

Declaration
public HistoryRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

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

Declaration
[RequestParameter("_at", RequestParameterType.Query)]
public virtual string At { get; set; }
Property Value
Type Description
string

Count

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

Declaration
[RequestParameter("_count", RequestParameterType.Query)]
public virtual int? Count { get; set; }
Property Value
Type Description
int?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Name

Required. The name of the resource to retrieve.

Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type Description
string

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.

Declaration
[RequestParameter("_page_token", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

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.

Declaration
[RequestParameter("_since", RequestParameterType.Query)]
public virtual string Since { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes History parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements