Class ExecuteCohortRequest

Request to execute a cohort definition from a FHIR store based on provided queries and sending the resulting subset of data to a specified sink.

Inheritance
object
ExecuteCohortRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1beta1.Data
Assembly: Google.Apis.CloudHealthcare.v1beta1.dll
Syntax
public class ExecuteCohortRequest : IDirectResponseSchema

Properties

At

object representation of AtRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use AtDateTimeOffset instead.")]
public virtual object At { get; set; }
Property Value
Type Description
object

AtDateTimeOffset

DateTimeOffset representation of AtRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? AtDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

AtRaw

Optional. If provided, the queried resources will represent the state of the FHIR store at the given past timestamp. Runs the operation against the state of the store at this timestamp. State of the store is represented by the resource versions that were the current versions during the time specified or the resources that have not been updated since. Only works if the store has history enabled. Although users should be able to use this field to reproduce previous runs of the operation and get consistent results, there are a few cases where the past state of the store can be altered, thus resulting in no guarantee of reproducibility. For example, resource versions can be deleted using the purge method, or modified using ImportResourcesHistory.

Declaration
[JsonProperty("_at")]
public virtual string AtRaw { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FhirpathQuery

Return resources that match the specified FHIRPath expressions.

Declaration
[JsonProperty("fhirpathQuery")]
public virtual FHIRPathQuery FhirpathQuery { get; set; }
Property Value
Type Description
FHIRPathQuery

GcsDestination

The Cloud Storage output destination. The Healthcare Service Agent account requires the roles/storage.objectAdmin role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one or more objects per resource type depending on the volume of the resources exported. When there is only one object per resource type, the object name is in the form of {operation_id}_{resource_type}. When there are multiple objects for a given resource type, the object names are in the form of {operation_id}_{resource_type}-{index}-of-{total}. Each object contains newline delimited JSON, and each line is a FHIR resource.

Declaration
[JsonProperty("gcsDestination")]
public virtual GoogleCloudHealthcareV1beta1FhirGcsDestination GcsDestination { get; set; }
Property Value
Type Description
GoogleCloudHealthcareV1beta1FhirGcsDestination

ValidateOnly

Optional. If true, the request will be validated but no cohort execution will be run.

Declaration
[JsonProperty("validateOnly")]
public virtual bool? ValidateOnly { get; set; }
Property Value
Type Description
bool?

Implements