Class FhirStore

A FhirStore is a datastore inside a Healthcare dataset that conforms to the FHIR (https://www.hl7.org/fhir/STU3/) standard for Healthcare information exchange

To get more information about FhirStore, see:

• API documentation
• How-to Guides
• Creating a FHIR store

Inheritance

System.Object

Resource

CustomResource

FhirStore

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Healthcare

Assembly: Pulumi.Gcp.dll

Syntax

public class FhirStore : CustomResource

Constructors

FhirStore(String, FhirStoreArgs, CustomResourceOptions)

Create a FhirStore resource with the given unique name, arguments, and options.

Declaration

public FhirStore(string name, FhirStoreArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
FhirStoreArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Dataset

Identifies the dataset addressed by this request. Must be in the format 'projects/{project}/locations/{location}/datasets/{dataset}'

Declaration

public Output<string> Dataset { get; }

Property Value

Type	Description
Output<System.String>

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 will enforce referential integrity and fail the requests that will result in inconsistent state in the FHIR store. When this field is set to true, the API will skip referential integrity check. Consequently, operations that rely on references, such as Patient.get$everything, will not return all the results if broken references exist. ** Changing this property may recreate the FHIR store (removing all data) **

Declaration

public Output<bool?> DisableReferentialIntegrity { get; }

Property Value

Type	Description
Output<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 will 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 will be kept. The server will send back errors for attempts to read the historical versions. ** Changing this property may recreate the FHIR store (removing all data) **

Declaration

public Output<bool?> DisableResourceVersioning { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

EnableHistoryImport

Whether to allow the bulk import API to accept history bundles and directly insert historical resource versions into the FHIR store. Importing resource histories creates resource interactions that appear to have occurred in the past, which clients may not want to allow. If set to false, history bundles within an import will fail with an error. ** Changing this property may recreate the FHIR store (removing all data) ** ** This property can be changed manually in the Google Cloud Healthcare admin console without recreating the FHIR store **

Declaration

public Output<bool?> EnableHistoryImport { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

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 will 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 will be part of the FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub notifications.

Declaration

public Output<bool?> EnableUpdateCreate { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

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}][\p{Ll}\p{Lo}\p{N}-]{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. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Declaration

public Output<ImmutableDictionary<string, string>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

Name

The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NotificationConfig

A nested object resource Structure is documented below.

Declaration

public Output<FhirStoreNotificationConfig> NotificationConfig { get; }

Property Value

Type	Description
Output<FhirStoreNotificationConfig>

SelfLink

The fully qualified name of this dataset

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

Version

The FHIR specification version.

Declaration

public Output<string> Version { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, FhirStoreState, CustomResourceOptions)

Get an existing FhirStore resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static FhirStore Get(string name, Input<string> id, FhirStoreState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
FhirStoreState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
FhirStore