Class FhirStore
Represents a FHIR store.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.CloudHealthcare.v1.Data
Assembly: Google.Apis.CloudHealthcare.v1.dll
Syntax
public class FhirStore : IDirectResponseSchema
Properties
DisableReferentialIntegrity
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 |
|---|---|
| System.Nullable<System.Boolean> |
DisableResourceVersioning
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, which is the default behavior, 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.
Declaration
[JsonProperty("disableResourceVersioning")]
public virtual bool? DisableResourceVersioning { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
EnableUpdateCreate
Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir /capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). 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. Please treat the audit logs with appropriate levels of care if client-specified resource IDs contain sensitive data such as patient identifiers, those IDs are part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications.
Declaration
[JsonProperty("enableUpdateCreate")]
public virtual bool? EnableUpdateCreate { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
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 |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.String> |
Name
Output only. Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NotificationConfig
If non-empty, publish all resource modifications of this FHIR store to this destination. The Cloud 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 |
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](https://cloud.google.com/bigquery/docs/access-
control#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 |
|---|---|
| System.Collections.Generic.IList<StreamConfig> |
Version
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.
Declaration
[JsonProperty("version")]
public virtual string Version { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |