Class ProjectsResource.LocationsResource.DatasetsResource.FhirStoresResource.FhirResource.PatientEverythingRequest

Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2, STU3, R4). On success, the response body contains a JSON-encoded representation of a Bundle resource of type searchset, containing the results of the operation. 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. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition (DSTU2, STU3, R4), which details the eligible resource types and referencing search parameters. For samples that show how to call Patient-everything, see Getting all patient compartment resources.

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

Constructors

PatientEverythingRequest(IClientService, string)

Constructs a new PatientEverything request.

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

Properties

Count

Optional. Maximum number of resources in 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?

End

Optional. The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope.

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

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. Name of the Patient resource for which the information is required.

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

PageToken

Used to retrieve the next or previous page of results when using pagination. Set _page_token to the value of _page_token set in next or previous page links' url. 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

Optional. If provided, only resources updated after this time are returned. The 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

Start

Optional. The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope.

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

Type

Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple _type parameters isn't supported. For example, the result of _type=Observation&amp;_type=Encounter is undefined. Use _type=Observation,Encounter instead.

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

Methods

InitParameters()

Initializes PatientEverything parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements