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 will contain a JSON-encoded representation of a Bundle
resource of type searchset, containing the results of the operation. 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.
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.
Inheritance
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class PatientEverythingRequest : CloudHealthcareBaseServiceRequest<HttpBody>, IClientServiceRequest<HttpBody>, IClientServiceRequestConstructors
PatientEverythingRequest(IClientService, String)
Constructs a new PatientEverything request.
Declaration
public PatientEverythingRequest(IClientService service, string name)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.String | name |
Properties
Count
Maximum number of resources in a page. Defaults to 100.
Declaration
[RequestParameter("_count", RequestParameterType.Query)]
public virtual int? Count { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
End
The response includes records prior to the end date. 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 |
|---|---|
| System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Name
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 |
|---|---|
| System.String |
PageToken
Used to retrieve the next or previous page of results 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 |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Start
The response includes records subsequent to the start date. 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 |
|---|---|
| System.String |
Methods
InitParameters()
Initializes PatientEverything parameter list.
Declaration
protected override void InitParameters()