Class FhirStore

Represents a FHIR store.

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

Properties

BulkExportGcsDestination

Optional. FHIR bulk export exports resources to the specified Cloud Storage destination. A Cloud Storage destination is a URI for a Cloud Storage directory where result files will be written. Only used in the spec-defined bulk $export methods. The Cloud Healthcare Service Agent requires the roles/storage.objectAdmin Cloud IAM role on the destination.

Declaration
[JsonProperty("bulkExportGcsDestination")]
public virtual BulkExportGcsDestination BulkExportGcsDestination { get; set; }
Property Value
Type Description
BulkExportGcsDestination

ComplexDataTypeReferenceParsing

Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.

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

ConsentConfig

Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.

Declaration
[JsonProperty("consentConfig")]
public virtual ConsentConfig ConsentConfig { get; set; }
Property Value
Type Description
ConsentConfig

DefaultSearchHandlingStrict

If true, overrides the default search behavior for this FHIR store to handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. Defaults to false.

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

DisableReferentialIntegrity

Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.

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

DisableResourceVersioning

Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.

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

ETag

The ETag of the item.

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

EnableHistoryModifications

Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.

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

EnableUpdateCreate

Whether this FHIR store has the updateCreate capability. This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.

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

Labels

User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

Output only. Identifier. Resource name of the FHIR store, of the form projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.

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

NotificationConfig

Deprecated. Use notification_configs instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".

Declaration
[JsonProperty("notificationConfig")]
public virtual NotificationConfig NotificationConfig { get; set; }
Property Value
Type Description
NotificationConfig

NotificationConfigs

Specifies where and whether to send notifications upon changes to a Fhir store.

Declaration
[JsonProperty("notificationConfigs")]
public virtual IList<FhirNotificationConfig> NotificationConfigs { get; set; }
Property Value
Type Description
IList<FhirNotificationConfig>

SearchConfig

Configuration for how FHIR resources can be searched.

Declaration
[JsonProperty("searchConfig")]
public virtual SearchConfig SearchConfig { get; set; }
Property Value
Type Description
SearchConfig

StreamConfigs

A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required bigquery.dataEditor role to your project's Cloud Healthcare Service Agent service account. Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.

Declaration
[JsonProperty("streamConfigs")]
public virtual IList<StreamConfig> StreamConfigs { get; set; }
Property Value
Type Description
IList<StreamConfig>

ValidationConfig

Configuration for how to validate incoming FHIR resources against configured profiles.

Declaration
[JsonProperty("validationConfig")]
public virtual ValidationConfig ValidationConfig { get; set; }
Property Value
Type Description
ValidationConfig

Version

Required. Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.

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

Implements