gcp.healthcare.FhirStore
Explore with Pulumi AI
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
Example Usage
Healthcare Fhir Store Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const topic = new gcp.pubsub.Topic("topic", {name: "fhir-notifications"});
const dataset = new gcp.healthcare.Dataset("dataset", {
name: "example-dataset",
location: "us-central1",
});
const _default = new gcp.healthcare.FhirStore("default", {
name: "example-fhir-store",
dataset: dataset.id,
version: "R4",
complexDataTypeReferenceParsing: "DISABLED",
enableUpdateCreate: false,
disableReferentialIntegrity: false,
disableResourceVersioning: false,
enableHistoryImport: false,
defaultSearchHandlingStrict: false,
notificationConfigs: [{
pubsubTopic: topic.id,
}],
labels: {
label1: "labelvalue1",
},
});
import pulumi
import pulumi_gcp as gcp
topic = gcp.pubsub.Topic("topic", name="fhir-notifications")
dataset = gcp.healthcare.Dataset("dataset",
name="example-dataset",
location="us-central1")
default = gcp.healthcare.FhirStore("default",
name="example-fhir-store",
dataset=dataset.id,
version="R4",
complex_data_type_reference_parsing="DISABLED",
enable_update_create=False,
disable_referential_integrity=False,
disable_resource_versioning=False,
enable_history_import=False,
default_search_handling_strict=False,
notification_configs=[{
"pubsub_topic": topic.id,
}],
labels={
"label1": "labelvalue1",
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/healthcare"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/pubsub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
topic, err := pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
Name: pulumi.String("fhir-notifications"),
})
if err != nil {
return err
}
dataset, err := healthcare.NewDataset(ctx, "dataset", &healthcare.DatasetArgs{
Name: pulumi.String("example-dataset"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
_, err = healthcare.NewFhirStore(ctx, "default", &healthcare.FhirStoreArgs{
Name: pulumi.String("example-fhir-store"),
Dataset: dataset.ID(),
Version: pulumi.String("R4"),
ComplexDataTypeReferenceParsing: pulumi.String("DISABLED"),
EnableUpdateCreate: pulumi.Bool(false),
DisableReferentialIntegrity: pulumi.Bool(false),
DisableResourceVersioning: pulumi.Bool(false),
EnableHistoryImport: pulumi.Bool(false),
DefaultSearchHandlingStrict: pulumi.Bool(false),
NotificationConfigs: healthcare.FhirStoreNotificationConfigArray{
&healthcare.FhirStoreNotificationConfigArgs{
PubsubTopic: topic.ID(),
},
},
Labels: pulumi.StringMap{
"label1": pulumi.String("labelvalue1"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var topic = new Gcp.PubSub.Topic("topic", new()
{
Name = "fhir-notifications",
});
var dataset = new Gcp.Healthcare.Dataset("dataset", new()
{
Name = "example-dataset",
Location = "us-central1",
});
var @default = new Gcp.Healthcare.FhirStore("default", new()
{
Name = "example-fhir-store",
Dataset = dataset.Id,
Version = "R4",
ComplexDataTypeReferenceParsing = "DISABLED",
EnableUpdateCreate = false,
DisableReferentialIntegrity = false,
DisableResourceVersioning = false,
EnableHistoryImport = false,
DefaultSearchHandlingStrict = false,
NotificationConfigs = new[]
{
new Gcp.Healthcare.Inputs.FhirStoreNotificationConfigArgs
{
PubsubTopic = topic.Id,
},
},
Labels =
{
{ "label1", "labelvalue1" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.healthcare.Dataset;
import com.pulumi.gcp.healthcare.DatasetArgs;
import com.pulumi.gcp.healthcare.FhirStore;
import com.pulumi.gcp.healthcare.FhirStoreArgs;
import com.pulumi.gcp.healthcare.inputs.FhirStoreNotificationConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var topic = new Topic("topic", TopicArgs.builder()
.name("fhir-notifications")
.build());
var dataset = new Dataset("dataset", DatasetArgs.builder()
.name("example-dataset")
.location("us-central1")
.build());
var default_ = new FhirStore("default", FhirStoreArgs.builder()
.name("example-fhir-store")
.dataset(dataset.id())
.version("R4")
.complexDataTypeReferenceParsing("DISABLED")
.enableUpdateCreate(false)
.disableReferentialIntegrity(false)
.disableResourceVersioning(false)
.enableHistoryImport(false)
.defaultSearchHandlingStrict(false)
.notificationConfigs(FhirStoreNotificationConfigArgs.builder()
.pubsubTopic(topic.id())
.build())
.labels(Map.of("label1", "labelvalue1"))
.build());
}
}
resources:
default:
type: gcp:healthcare:FhirStore
properties:
name: example-fhir-store
dataset: ${dataset.id}
version: R4
complexDataTypeReferenceParsing: DISABLED
enableUpdateCreate: false
disableReferentialIntegrity: false
disableResourceVersioning: false
enableHistoryImport: false
defaultSearchHandlingStrict: false
notificationConfigs:
- pubsubTopic: ${topic.id}
labels:
label1: labelvalue1
topic:
type: gcp:pubsub:Topic
properties:
name: fhir-notifications
dataset:
type: gcp:healthcare:Dataset
properties:
name: example-dataset
location: us-central1
Healthcare Fhir Store Streaming Config
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const dataset = new gcp.healthcare.Dataset("dataset", {
name: "example-dataset",
location: "us-central1",
});
const bqDataset = new gcp.bigquery.Dataset("bq_dataset", {
datasetId: "bq_example_dataset",
friendlyName: "test",
description: "This is a test description",
location: "US",
deleteContentsOnDestroy: true,
});
const _default = new gcp.healthcare.FhirStore("default", {
name: "example-fhir-store",
dataset: dataset.id,
version: "R4",
enableUpdateCreate: false,
disableReferentialIntegrity: false,
disableResourceVersioning: false,
enableHistoryImport: false,
labels: {
label1: "labelvalue1",
},
streamConfigs: [{
resourceTypes: ["Observation"],
bigqueryDestination: {
datasetUri: pulumi.interpolate`bq://${bqDataset.project}.${bqDataset.datasetId}`,
schemaConfig: {
recursiveStructureDepth: 3,
lastUpdatedPartitionConfig: {
type: "HOUR",
expirationMs: "1000000",
},
},
},
}],
});
const topic = new gcp.pubsub.Topic("topic", {name: "fhir-notifications"});
import pulumi
import pulumi_gcp as gcp
dataset = gcp.healthcare.Dataset("dataset",
name="example-dataset",
location="us-central1")
bq_dataset = gcp.bigquery.Dataset("bq_dataset",
dataset_id="bq_example_dataset",
friendly_name="test",
description="This is a test description",
location="US",
delete_contents_on_destroy=True)
default = gcp.healthcare.FhirStore("default",
name="example-fhir-store",
dataset=dataset.id,
version="R4",
enable_update_create=False,
disable_referential_integrity=False,
disable_resource_versioning=False,
enable_history_import=False,
labels={
"label1": "labelvalue1",
},
stream_configs=[{
"resource_types": ["Observation"],
"bigquery_destination": {
"dataset_uri": pulumi.Output.all(
project=bq_dataset.project,
dataset_id=bq_dataset.dataset_id
).apply(lambda resolved_outputs: f"bq://{resolved_outputs['project']}.{resolved_outputs['dataset_id']}")
,
"schema_config": {
"recursive_structure_depth": 3,
"last_updated_partition_config": {
"type": "HOUR",
"expiration_ms": "1000000",
},
},
},
}])
topic = gcp.pubsub.Topic("topic", name="fhir-notifications")
package main
import (
"fmt"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/healthcare"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/pubsub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
dataset, err := healthcare.NewDataset(ctx, "dataset", &healthcare.DatasetArgs{
Name: pulumi.String("example-dataset"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
bqDataset, err := bigquery.NewDataset(ctx, "bq_dataset", &bigquery.DatasetArgs{
DatasetId: pulumi.String("bq_example_dataset"),
FriendlyName: pulumi.String("test"),
Description: pulumi.String("This is a test description"),
Location: pulumi.String("US"),
DeleteContentsOnDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = healthcare.NewFhirStore(ctx, "default", &healthcare.FhirStoreArgs{
Name: pulumi.String("example-fhir-store"),
Dataset: dataset.ID(),
Version: pulumi.String("R4"),
EnableUpdateCreate: pulumi.Bool(false),
DisableReferentialIntegrity: pulumi.Bool(false),
DisableResourceVersioning: pulumi.Bool(false),
EnableHistoryImport: pulumi.Bool(false),
Labels: pulumi.StringMap{
"label1": pulumi.String("labelvalue1"),
},
StreamConfigs: healthcare.FhirStoreStreamConfigArray{
&healthcare.FhirStoreStreamConfigArgs{
ResourceTypes: pulumi.StringArray{
pulumi.String("Observation"),
},
BigqueryDestination: &healthcare.FhirStoreStreamConfigBigqueryDestinationArgs{
DatasetUri: pulumi.All(bqDataset.Project, bqDataset.DatasetId).ApplyT(func(_args []interface{}) (string, error) {
project := _args[0].(string)
datasetId := _args[1].(string)
return fmt.Sprintf("bq://%v.%v", project, datasetId), nil
}).(pulumi.StringOutput),
SchemaConfig: &healthcare.FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs{
RecursiveStructureDepth: pulumi.Int(3),
LastUpdatedPartitionConfig: &healthcare.FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs{
Type: pulumi.String("HOUR"),
ExpirationMs: pulumi.String("1000000"),
},
},
},
},
},
})
if err != nil {
return err
}
_, err = pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
Name: pulumi.String("fhir-notifications"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var dataset = new Gcp.Healthcare.Dataset("dataset", new()
{
Name = "example-dataset",
Location = "us-central1",
});
var bqDataset = new Gcp.BigQuery.Dataset("bq_dataset", new()
{
DatasetId = "bq_example_dataset",
FriendlyName = "test",
Description = "This is a test description",
Location = "US",
DeleteContentsOnDestroy = true,
});
var @default = new Gcp.Healthcare.FhirStore("default", new()
{
Name = "example-fhir-store",
Dataset = dataset.Id,
Version = "R4",
EnableUpdateCreate = false,
DisableReferentialIntegrity = false,
DisableResourceVersioning = false,
EnableHistoryImport = false,
Labels =
{
{ "label1", "labelvalue1" },
},
StreamConfigs = new[]
{
new Gcp.Healthcare.Inputs.FhirStoreStreamConfigArgs
{
ResourceTypes = new[]
{
"Observation",
},
BigqueryDestination = new Gcp.Healthcare.Inputs.FhirStoreStreamConfigBigqueryDestinationArgs
{
DatasetUri = Output.Tuple(bqDataset.Project, bqDataset.DatasetId).Apply(values =>
{
var project = values.Item1;
var datasetId = values.Item2;
return $"bq://{project}.{datasetId}";
}),
SchemaConfig = new Gcp.Healthcare.Inputs.FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs
{
RecursiveStructureDepth = 3,
LastUpdatedPartitionConfig = new Gcp.Healthcare.Inputs.FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs
{
Type = "HOUR",
ExpirationMs = "1000000",
},
},
},
},
},
});
var topic = new Gcp.PubSub.Topic("topic", new()
{
Name = "fhir-notifications",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.healthcare.Dataset;
import com.pulumi.gcp.healthcare.DatasetArgs;
import com.pulumi.gcp.bigquery.Dataset;
import com.pulumi.gcp.bigquery.DatasetArgs;
import com.pulumi.gcp.healthcare.FhirStore;
import com.pulumi.gcp.healthcare.FhirStoreArgs;
import com.pulumi.gcp.healthcare.inputs.FhirStoreStreamConfigArgs;
import com.pulumi.gcp.healthcare.inputs.FhirStoreStreamConfigBigqueryDestinationArgs;
import com.pulumi.gcp.healthcare.inputs.FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs;
import com.pulumi.gcp.healthcare.inputs.FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var dataset = new Dataset("dataset", DatasetArgs.builder()
.name("example-dataset")
.location("us-central1")
.build());
var bqDataset = new Dataset("bqDataset", DatasetArgs.builder()
.datasetId("bq_example_dataset")
.friendlyName("test")
.description("This is a test description")
.location("US")
.deleteContentsOnDestroy(true)
.build());
var default_ = new FhirStore("default", FhirStoreArgs.builder()
.name("example-fhir-store")
.dataset(dataset.id())
.version("R4")
.enableUpdateCreate(false)
.disableReferentialIntegrity(false)
.disableResourceVersioning(false)
.enableHistoryImport(false)
.labels(Map.of("label1", "labelvalue1"))
.streamConfigs(FhirStoreStreamConfigArgs.builder()
.resourceTypes("Observation")
.bigqueryDestination(FhirStoreStreamConfigBigqueryDestinationArgs.builder()
.datasetUri(Output.tuple(bqDataset.project(), bqDataset.datasetId()).applyValue(values -> {
var project = values.t1;
var datasetId = values.t2;
return String.format("bq://%s.%s", project,datasetId);
}))
.schemaConfig(FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs.builder()
.recursiveStructureDepth(3)
.lastUpdatedPartitionConfig(FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs.builder()
.type("HOUR")
.expirationMs(1000000)
.build())
.build())
.build())
.build())
.build());
var topic = new Topic("topic", TopicArgs.builder()
.name("fhir-notifications")
.build());
}
}
resources:
default:
type: gcp:healthcare:FhirStore
properties:
name: example-fhir-store
dataset: ${dataset.id}
version: R4
enableUpdateCreate: false
disableReferentialIntegrity: false
disableResourceVersioning: false
enableHistoryImport: false
labels:
label1: labelvalue1
streamConfigs:
- resourceTypes:
- Observation
bigqueryDestination:
datasetUri: bq://${bqDataset.project}.${bqDataset.datasetId}
schemaConfig:
recursiveStructureDepth: 3
lastUpdatedPartitionConfig:
type: HOUR
expirationMs: 1e+06
topic:
type: gcp:pubsub:Topic
properties:
name: fhir-notifications
dataset:
type: gcp:healthcare:Dataset
properties:
name: example-dataset
location: us-central1
bqDataset:
type: gcp:bigquery:Dataset
name: bq_dataset
properties:
datasetId: bq_example_dataset
friendlyName: test
description: This is a test description
location: US
deleteContentsOnDestroy: true
Healthcare Fhir Store Notification Configs
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const topic = new gcp.pubsub.Topic("topic", {name: "fhir-notifications"});
const dataset = new gcp.healthcare.Dataset("dataset", {
name: "example-dataset",
location: "us-central1",
});
const _default = new gcp.healthcare.FhirStore("default", {
name: "example-fhir-store",
dataset: dataset.id,
version: "R4",
enableUpdateCreate: false,
disableReferentialIntegrity: false,
disableResourceVersioning: false,
enableHistoryImport: false,
labels: {
label1: "labelvalue1",
},
notificationConfigs: [{
pubsubTopic: topic.id,
sendFullResource: true,
sendPreviousResourceOnDelete: true,
}],
});
import pulumi
import pulumi_gcp as gcp
topic = gcp.pubsub.Topic("topic", name="fhir-notifications")
dataset = gcp.healthcare.Dataset("dataset",
name="example-dataset",
location="us-central1")
default = gcp.healthcare.FhirStore("default",
name="example-fhir-store",
dataset=dataset.id,
version="R4",
enable_update_create=False,
disable_referential_integrity=False,
disable_resource_versioning=False,
enable_history_import=False,
labels={
"label1": "labelvalue1",
},
notification_configs=[{
"pubsub_topic": topic.id,
"send_full_resource": True,
"send_previous_resource_on_delete": True,
}])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/healthcare"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/pubsub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
topic, err := pubsub.NewTopic(ctx, "topic", &pubsub.TopicArgs{
Name: pulumi.String("fhir-notifications"),
})
if err != nil {
return err
}
dataset, err := healthcare.NewDataset(ctx, "dataset", &healthcare.DatasetArgs{
Name: pulumi.String("example-dataset"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
_, err = healthcare.NewFhirStore(ctx, "default", &healthcare.FhirStoreArgs{
Name: pulumi.String("example-fhir-store"),
Dataset: dataset.ID(),
Version: pulumi.String("R4"),
EnableUpdateCreate: pulumi.Bool(false),
DisableReferentialIntegrity: pulumi.Bool(false),
DisableResourceVersioning: pulumi.Bool(false),
EnableHistoryImport: pulumi.Bool(false),
Labels: pulumi.StringMap{
"label1": pulumi.String("labelvalue1"),
},
NotificationConfigs: healthcare.FhirStoreNotificationConfigArray{
&healthcare.FhirStoreNotificationConfigArgs{
PubsubTopic: topic.ID(),
SendFullResource: pulumi.Bool(true),
SendPreviousResourceOnDelete: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var topic = new Gcp.PubSub.Topic("topic", new()
{
Name = "fhir-notifications",
});
var dataset = new Gcp.Healthcare.Dataset("dataset", new()
{
Name = "example-dataset",
Location = "us-central1",
});
var @default = new Gcp.Healthcare.FhirStore("default", new()
{
Name = "example-fhir-store",
Dataset = dataset.Id,
Version = "R4",
EnableUpdateCreate = false,
DisableReferentialIntegrity = false,
DisableResourceVersioning = false,
EnableHistoryImport = false,
Labels =
{
{ "label1", "labelvalue1" },
},
NotificationConfigs = new[]
{
new Gcp.Healthcare.Inputs.FhirStoreNotificationConfigArgs
{
PubsubTopic = topic.Id,
SendFullResource = true,
SendPreviousResourceOnDelete = true,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.healthcare.Dataset;
import com.pulumi.gcp.healthcare.DatasetArgs;
import com.pulumi.gcp.healthcare.FhirStore;
import com.pulumi.gcp.healthcare.FhirStoreArgs;
import com.pulumi.gcp.healthcare.inputs.FhirStoreNotificationConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var topic = new Topic("topic", TopicArgs.builder()
.name("fhir-notifications")
.build());
var dataset = new Dataset("dataset", DatasetArgs.builder()
.name("example-dataset")
.location("us-central1")
.build());
var default_ = new FhirStore("default", FhirStoreArgs.builder()
.name("example-fhir-store")
.dataset(dataset.id())
.version("R4")
.enableUpdateCreate(false)
.disableReferentialIntegrity(false)
.disableResourceVersioning(false)
.enableHistoryImport(false)
.labels(Map.of("label1", "labelvalue1"))
.notificationConfigs(FhirStoreNotificationConfigArgs.builder()
.pubsubTopic(topic.id())
.sendFullResource(true)
.sendPreviousResourceOnDelete(true)
.build())
.build());
}
}
resources:
default:
type: gcp:healthcare:FhirStore
properties:
name: example-fhir-store
dataset: ${dataset.id}
version: R4
enableUpdateCreate: false
disableReferentialIntegrity: false
disableResourceVersioning: false
enableHistoryImport: false
labels:
label1: labelvalue1
notificationConfigs:
- pubsubTopic: ${topic.id}
sendFullResource: true
sendPreviousResourceOnDelete: true
topic:
type: gcp:pubsub:Topic
properties:
name: fhir-notifications
dataset:
type: gcp:healthcare:Dataset
properties:
name: example-dataset
location: us-central1
Create FhirStore Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FhirStore(name: string, args: FhirStoreArgs, opts?: CustomResourceOptions);
@overload
def FhirStore(resource_name: str,
args: FhirStoreArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FhirStore(resource_name: str,
opts: Optional[ResourceOptions] = None,
dataset: Optional[str] = None,
enable_history_modifications: Optional[bool] = None,
default_search_handling_strict: Optional[bool] = None,
disable_referential_integrity: Optional[bool] = None,
disable_resource_versioning: Optional[bool] = None,
enable_history_import: Optional[bool] = None,
complex_data_type_reference_parsing: Optional[str] = None,
enable_update_create: Optional[bool] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
notification_config: Optional[FhirStoreNotificationConfigArgs] = None,
notification_configs: Optional[Sequence[FhirStoreNotificationConfigArgs]] = None,
stream_configs: Optional[Sequence[FhirStoreStreamConfigArgs]] = None,
version: Optional[str] = None)
func NewFhirStore(ctx *Context, name string, args FhirStoreArgs, opts ...ResourceOption) (*FhirStore, error)
public FhirStore(string name, FhirStoreArgs args, CustomResourceOptions? opts = null)
public FhirStore(String name, FhirStoreArgs args)
public FhirStore(String name, FhirStoreArgs args, CustomResourceOptions options)
type: gcp:healthcare:FhirStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FhirStoreArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FhirStoreArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FhirStoreArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FhirStoreArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FhirStoreArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var fhirStoreResource = new Gcp.Healthcare.FhirStore("fhirStoreResource", new()
{
Dataset = "string",
EnableHistoryModifications = false,
DefaultSearchHandlingStrict = false,
DisableReferentialIntegrity = false,
DisableResourceVersioning = false,
EnableHistoryImport = false,
ComplexDataTypeReferenceParsing = "string",
EnableUpdateCreate = false,
Labels =
{
{ "string", "string" },
},
Name = "string",
NotificationConfigs = new[]
{
new Gcp.Healthcare.Inputs.FhirStoreNotificationConfigArgs
{
PubsubTopic = "string",
SendFullResource = false,
SendPreviousResourceOnDelete = false,
},
},
StreamConfigs = new[]
{
new Gcp.Healthcare.Inputs.FhirStoreStreamConfigArgs
{
BigqueryDestination = new Gcp.Healthcare.Inputs.FhirStoreStreamConfigBigqueryDestinationArgs
{
DatasetUri = "string",
SchemaConfig = new Gcp.Healthcare.Inputs.FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs
{
RecursiveStructureDepth = 0,
LastUpdatedPartitionConfig = new Gcp.Healthcare.Inputs.FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs
{
Type = "string",
ExpirationMs = "string",
},
SchemaType = "string",
},
},
ResourceTypes = new[]
{
"string",
},
},
},
Version = "string",
});
example, err := healthcare.NewFhirStore(ctx, "fhirStoreResource", &healthcare.FhirStoreArgs{
Dataset: pulumi.String("string"),
EnableHistoryModifications: pulumi.Bool(false),
DefaultSearchHandlingStrict: pulumi.Bool(false),
DisableReferentialIntegrity: pulumi.Bool(false),
DisableResourceVersioning: pulumi.Bool(false),
EnableHistoryImport: pulumi.Bool(false),
ComplexDataTypeReferenceParsing: pulumi.String("string"),
EnableUpdateCreate: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
NotificationConfigs: healthcare.FhirStoreNotificationConfigArray{
&healthcare.FhirStoreNotificationConfigArgs{
PubsubTopic: pulumi.String("string"),
SendFullResource: pulumi.Bool(false),
SendPreviousResourceOnDelete: pulumi.Bool(false),
},
},
StreamConfigs: healthcare.FhirStoreStreamConfigArray{
&healthcare.FhirStoreStreamConfigArgs{
BigqueryDestination: &healthcare.FhirStoreStreamConfigBigqueryDestinationArgs{
DatasetUri: pulumi.String("string"),
SchemaConfig: &healthcare.FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs{
RecursiveStructureDepth: pulumi.Int(0),
LastUpdatedPartitionConfig: &healthcare.FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs{
Type: pulumi.String("string"),
ExpirationMs: pulumi.String("string"),
},
SchemaType: pulumi.String("string"),
},
},
ResourceTypes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Version: pulumi.String("string"),
})
var fhirStoreResource = new FhirStore("fhirStoreResource", FhirStoreArgs.builder()
.dataset("string")
.enableHistoryModifications(false)
.defaultSearchHandlingStrict(false)
.disableReferentialIntegrity(false)
.disableResourceVersioning(false)
.enableHistoryImport(false)
.complexDataTypeReferenceParsing("string")
.enableUpdateCreate(false)
.labels(Map.of("string", "string"))
.name("string")
.notificationConfigs(FhirStoreNotificationConfigArgs.builder()
.pubsubTopic("string")
.sendFullResource(false)
.sendPreviousResourceOnDelete(false)
.build())
.streamConfigs(FhirStoreStreamConfigArgs.builder()
.bigqueryDestination(FhirStoreStreamConfigBigqueryDestinationArgs.builder()
.datasetUri("string")
.schemaConfig(FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs.builder()
.recursiveStructureDepth(0)
.lastUpdatedPartitionConfig(FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs.builder()
.type("string")
.expirationMs("string")
.build())
.schemaType("string")
.build())
.build())
.resourceTypes("string")
.build())
.version("string")
.build());
fhir_store_resource = gcp.healthcare.FhirStore("fhirStoreResource",
dataset="string",
enable_history_modifications=False,
default_search_handling_strict=False,
disable_referential_integrity=False,
disable_resource_versioning=False,
enable_history_import=False,
complex_data_type_reference_parsing="string",
enable_update_create=False,
labels={
"string": "string",
},
name="string",
notification_configs=[{
"pubsub_topic": "string",
"send_full_resource": False,
"send_previous_resource_on_delete": False,
}],
stream_configs=[{
"bigquery_destination": {
"dataset_uri": "string",
"schema_config": {
"recursive_structure_depth": 0,
"last_updated_partition_config": {
"type": "string",
"expiration_ms": "string",
},
"schema_type": "string",
},
},
"resource_types": ["string"],
}],
version="string")
const fhirStoreResource = new gcp.healthcare.FhirStore("fhirStoreResource", {
dataset: "string",
enableHistoryModifications: false,
defaultSearchHandlingStrict: false,
disableReferentialIntegrity: false,
disableResourceVersioning: false,
enableHistoryImport: false,
complexDataTypeReferenceParsing: "string",
enableUpdateCreate: false,
labels: {
string: "string",
},
name: "string",
notificationConfigs: [{
pubsubTopic: "string",
sendFullResource: false,
sendPreviousResourceOnDelete: false,
}],
streamConfigs: [{
bigqueryDestination: {
datasetUri: "string",
schemaConfig: {
recursiveStructureDepth: 0,
lastUpdatedPartitionConfig: {
type: "string",
expirationMs: "string",
},
schemaType: "string",
},
},
resourceTypes: ["string"],
}],
version: "string",
});
type: gcp:healthcare:FhirStore
properties:
complexDataTypeReferenceParsing: string
dataset: string
defaultSearchHandlingStrict: false
disableReferentialIntegrity: false
disableResourceVersioning: false
enableHistoryImport: false
enableHistoryModifications: false
enableUpdateCreate: false
labels:
string: string
name: string
notificationConfigs:
- pubsubTopic: string
sendFullResource: false
sendPreviousResourceOnDelete: false
streamConfigs:
- bigqueryDestination:
datasetUri: string
schemaConfig:
lastUpdatedPartitionConfig:
expirationMs: string
type: string
recursiveStructureDepth: 0
schemaType: string
resourceTypes:
- string
version: string
FhirStore Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FhirStore resource accepts the following input properties:
- Dataset string
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- Complex
Data stringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - Default
Search boolHandling Strict - 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.
- Disable
Referential boolIntegrity - 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) **
- Disable
Resource boolVersioning - 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) **
- Enable
History boolImport - 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 **
- Enable
History boolModifications - Whether to allow the ExecuteBundle API 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.
- Enable
Update boolCreate - 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.
- Labels Dictionary<string, string>
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Name string
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- Notification
Config FhirStore Notification Config (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- Notification
Configs List<FhirStore Notification Config> - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- Stream
Configs List<FhirStore Stream Config> - 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. Structure is documented below.
- Version string
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- Dataset string
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- Complex
Data stringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - Default
Search boolHandling Strict - 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.
- Disable
Referential boolIntegrity - 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) **
- Disable
Resource boolVersioning - 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) **
- Enable
History boolImport - 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 **
- Enable
History boolModifications - Whether to allow the ExecuteBundle API 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.
- Enable
Update boolCreate - 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.
- Labels map[string]string
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Name string
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- Notification
Config FhirStore Notification Config Args (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- Notification
Configs []FhirStore Notification Config Args - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- Stream
Configs []FhirStore Stream Config Args - 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. Structure is documented below.
- Version string
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- dataset String
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- complex
Data StringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - default
Search BooleanHandling Strict - 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.
- disable
Referential BooleanIntegrity - 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) **
- disable
Resource BooleanVersioning - 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) **
- enable
History BooleanImport - 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 **
- enable
History BooleanModifications - Whether to allow the ExecuteBundle API 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.
- enable
Update BooleanCreate - 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.
- labels Map<String,String>
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name String
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification
Config FhirStore Notification Config (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification
Configs List<FhirStore Notification Config> - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- stream
Configs List<FhirStore Stream Config> - 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. Structure is documented below.
- version String
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- dataset string
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- complex
Data stringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - default
Search booleanHandling Strict - 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.
- disable
Referential booleanIntegrity - 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) **
- disable
Resource booleanVersioning - 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) **
- enable
History booleanImport - 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 **
- enable
History booleanModifications - Whether to allow the ExecuteBundle API 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.
- enable
Update booleanCreate - 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.
- labels {[key: string]: string}
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name string
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification
Config FhirStore Notification Config (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification
Configs FhirStore Notification Config[] - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- stream
Configs FhirStore Stream Config[] - 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. Structure is documented below.
- version string
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- dataset str
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- complex_
data_ strtype_ reference_ parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - default_
search_ boolhandling_ strict - 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.
- disable_
referential_ boolintegrity - 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) **
- disable_
resource_ boolversioning - 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) **
- enable_
history_ boolimport - 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 **
- enable_
history_ boolmodifications - Whether to allow the ExecuteBundle API 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.
- enable_
update_ boolcreate - 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.
- labels Mapping[str, str]
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name str
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification_
config FhirStore Notification Config Args (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification_
configs Sequence[FhirStore Notification Config Args] - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- stream_
configs Sequence[FhirStore Stream Config Args] - 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. Structure is documented below.
- version str
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- dataset String
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- complex
Data StringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - default
Search BooleanHandling Strict - 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.
- disable
Referential BooleanIntegrity - 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) **
- disable
Resource BooleanVersioning - 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) **
- enable
History BooleanImport - 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 **
- enable
History BooleanModifications - Whether to allow the ExecuteBundle API 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.
- enable
Update BooleanCreate - 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.
- labels Map<String>
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name String
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification
Config Property Map (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification
Configs List<Property Map> - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- stream
Configs List<Property Map> - 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. Structure is documented below.
- version String
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
Outputs
All input properties are implicitly available as output properties. Additionally, the FhirStore resource produces the following output properties:
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Self
Link string - The fully qualified name of this dataset
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Id string
- The provider-assigned unique ID for this managed resource.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Self
Link string - The fully qualified name of this dataset
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link String - The fully qualified name of this dataset
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id string
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link string - The fully qualified name of this dataset
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id str
- The provider-assigned unique ID for this managed resource.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- self_
link str - The fully qualified name of this dataset
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- id String
- The provider-assigned unique ID for this managed resource.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link String - The fully qualified name of this dataset
Look up Existing FhirStore Resource
Get an existing FhirStore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FhirStoreState, opts?: CustomResourceOptions): FhirStore
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
complex_data_type_reference_parsing: Optional[str] = None,
dataset: Optional[str] = None,
default_search_handling_strict: Optional[bool] = None,
disable_referential_integrity: Optional[bool] = None,
disable_resource_versioning: Optional[bool] = None,
effective_labels: Optional[Mapping[str, str]] = None,
enable_history_import: Optional[bool] = None,
enable_history_modifications: Optional[bool] = None,
enable_update_create: Optional[bool] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
notification_config: Optional[FhirStoreNotificationConfigArgs] = None,
notification_configs: Optional[Sequence[FhirStoreNotificationConfigArgs]] = None,
pulumi_labels: Optional[Mapping[str, str]] = None,
self_link: Optional[str] = None,
stream_configs: Optional[Sequence[FhirStoreStreamConfigArgs]] = None,
version: Optional[str] = None) -> FhirStore
func GetFhirStore(ctx *Context, name string, id IDInput, state *FhirStoreState, opts ...ResourceOption) (*FhirStore, error)
public static FhirStore Get(string name, Input<string> id, FhirStoreState? state, CustomResourceOptions? opts = null)
public static FhirStore get(String name, Output<String> id, FhirStoreState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Complex
Data stringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - Dataset string
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- Default
Search boolHandling Strict - 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.
- Disable
Referential boolIntegrity - 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) **
- Disable
Resource boolVersioning - 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) **
- Effective
Labels Dictionary<string, string> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Enable
History boolImport - 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 **
- Enable
History boolModifications - Whether to allow the ExecuteBundle API 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.
- Enable
Update boolCreate - 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.
- Labels Dictionary<string, string>
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Name string
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- Notification
Config FhirStore Notification Config (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- Notification
Configs List<FhirStore Notification Config> - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- Pulumi
Labels Dictionary<string, string> - The combination of labels configured directly on the resource and default labels configured on the provider.
- Self
Link string - The fully qualified name of this dataset
- Stream
Configs List<FhirStore Stream Config> - 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. Structure is documented below.
- Version string
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- Complex
Data stringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - Dataset string
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- Default
Search boolHandling Strict - 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.
- Disable
Referential boolIntegrity - 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) **
- Disable
Resource boolVersioning - 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) **
- Effective
Labels map[string]string - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- Enable
History boolImport - 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 **
- Enable
History boolModifications - Whether to allow the ExecuteBundle API 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.
- Enable
Update boolCreate - 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.
- Labels map[string]string
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- Name string
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- Notification
Config FhirStore Notification Config Args (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- Notification
Configs []FhirStore Notification Config Args - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- Pulumi
Labels map[string]string - The combination of labels configured directly on the resource and default labels configured on the provider.
- Self
Link string - The fully qualified name of this dataset
- Stream
Configs []FhirStore Stream Config Args - 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. Structure is documented below.
- Version string
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- complex
Data StringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - dataset String
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- default
Search BooleanHandling Strict - 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.
- disable
Referential BooleanIntegrity - 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) **
- disable
Resource BooleanVersioning - 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) **
- effective
Labels Map<String,String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- enable
History BooleanImport - 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 **
- enable
History BooleanModifications - Whether to allow the ExecuteBundle API 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.
- enable
Update BooleanCreate - 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.
- labels Map<String,String>
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name String
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification
Config FhirStore Notification Config (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification
Configs List<FhirStore Notification Config> - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- pulumi
Labels Map<String,String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link String - The fully qualified name of this dataset
- stream
Configs List<FhirStore Stream Config> - 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. Structure is documented below.
- version String
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- complex
Data stringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - dataset string
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- default
Search booleanHandling Strict - 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.
- disable
Referential booleanIntegrity - 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) **
- disable
Resource booleanVersioning - 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) **
- effective
Labels {[key: string]: string} - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- enable
History booleanImport - 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 **
- enable
History booleanModifications - Whether to allow the ExecuteBundle API 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.
- enable
Update booleanCreate - 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.
- labels {[key: string]: string}
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name string
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification
Config FhirStore Notification Config (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification
Configs FhirStore Notification Config[] - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- pulumi
Labels {[key: string]: string} - The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link string - The fully qualified name of this dataset
- stream
Configs FhirStore Stream Config[] - 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. Structure is documented below.
- version string
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- complex_
data_ strtype_ reference_ parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - dataset str
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- default_
search_ boolhandling_ strict - 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.
- disable_
referential_ boolintegrity - 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) **
- disable_
resource_ boolversioning - 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) **
- effective_
labels Mapping[str, str] - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- enable_
history_ boolimport - 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 **
- enable_
history_ boolmodifications - Whether to allow the ExecuteBundle API 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.
- enable_
update_ boolcreate - 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.
- labels Mapping[str, str]
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name str
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification_
config FhirStore Notification Config Args (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification_
configs Sequence[FhirStore Notification Config Args] - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- pulumi_
labels Mapping[str, str] - The combination of labels configured directly on the resource and default labels configured on the provider.
- self_
link str - The fully qualified name of this dataset
- stream_
configs Sequence[FhirStore Stream Config Args] - 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. Structure is documented below.
- version str
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
- complex
Data StringType Reference Parsing - 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 by default after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
Possible values are:
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
,DISABLED
,ENABLED
. - dataset String
- Identifies the dataset addressed by this request. Must be in the format
'projects/{project}/locations/{location}/datasets/{dataset}'
- default
Search BooleanHandling Strict - 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.
- disable
Referential BooleanIntegrity - 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) **
- disable
Resource BooleanVersioning - 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) **
- effective
Labels Map<String> - All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
- enable
History BooleanImport - 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 **
- enable
History BooleanModifications - Whether to allow the ExecuteBundle API 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.
- enable
Update BooleanCreate - 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.
- labels Map<String>
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" }.
Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field
effective_labels
for all of the labels present on the resource.- name String
- The resource name for the FhirStore. ** Changing this property may recreate the FHIR store (removing all data) **
- notification
Config Property Map (Optional, Deprecated) A nested object resource. Structure is documented below.
Warning:
notification_config
is deprecated and will be removed in a future major release. Usenotification_configs
instead.- notification
Configs List<Property Map> - A list of notifcation configs that configure the notification for every resource mutation in this FHIR store. Structure is documented below.
- pulumi
Labels Map<String> - The combination of labels configured directly on the resource and default labels configured on the provider.
- self
Link String - The fully qualified name of this dataset
- stream
Configs List<Property Map> - 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. Structure is documented below.
- version String
- The FHIR specification version.
Default value is
STU3
. Possible values are:DSTU2
,STU3
,R4
.
Supporting Types
FhirStoreNotificationConfig, FhirStoreNotificationConfigArgs
- Pubsub
Topic string - The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- Send
Full boolResource - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
- Send
Previous boolResource On Delete - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
- Pubsub
Topic string - The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- Send
Full boolResource - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
- Send
Previous boolResource On Delete - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
- pubsub
Topic String - The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- send
Full BooleanResource - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
- send
Previous BooleanResource On Delete - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
- pubsub
Topic string - The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- send
Full booleanResource - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
- send
Previous booleanResource On Delete - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
- pubsub_
topic str - The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- send_
full_ boolresource - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
- send_
previous_ boolresource_ on_ delete - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
- pubsub
Topic String - The Cloud Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data will contain the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com must have publisher permissions on the given Cloud Pub/Sub topic. Not having adequate permissions will cause the calls that send notifications to fail.
- send
Full BooleanResource - Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.
- send
Previous BooleanResource On Delete - Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.
FhirStoreStreamConfig, FhirStoreStreamConfigArgs
- Bigquery
Destination FhirStore Stream Config Bigquery Destination - The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. See the streaming config reference for more details. Structure is documented below.
- Resource
Types List<string> - Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.
- Bigquery
Destination FhirStore Stream Config Bigquery Destination - The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. See the streaming config reference for more details. Structure is documented below.
- Resource
Types []string - Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.
- bigquery
Destination FhirStore Stream Config Bigquery Destination - The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. See the streaming config reference for more details. Structure is documented below.
- resource
Types List<String> - Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.
- bigquery
Destination FhirStore Stream Config Bigquery Destination - The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. See the streaming config reference for more details. Structure is documented below.
- resource
Types string[] - Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.
- bigquery_
destination FhirStore Stream Config Bigquery Destination - The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. See the streaming config reference for more details. Structure is documented below.
- resource_
types Sequence[str] - Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.
- bigquery
Destination Property Map - The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types, e.g. "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. See the streaming config reference for more details. Structure is documented below.
- resource
Types List<String> - Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.
FhirStoreStreamConfigBigqueryDestination, FhirStoreStreamConfigBigqueryDestinationArgs
- Dataset
Uri string - BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId
- Schema
Config FhirStore Stream Config Bigquery Destination Schema Config - The configuration for the exported BigQuery schema. Structure is documented below.
- Dataset
Uri string - BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId
- Schema
Config FhirStore Stream Config Bigquery Destination Schema Config - The configuration for the exported BigQuery schema. Structure is documented below.
- dataset
Uri String - BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId
- schema
Config FhirStore Stream Config Bigquery Destination Schema Config - The configuration for the exported BigQuery schema. Structure is documented below.
- dataset
Uri string - BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId
- schema
Config FhirStore Stream Config Bigquery Destination Schema Config - The configuration for the exported BigQuery schema. Structure is documented below.
- dataset_
uri str - BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId
- schema_
config FhirStore Stream Config Bigquery Destination Schema Config - The configuration for the exported BigQuery schema. Structure is documented below.
- dataset
Uri String - BigQuery URI to a dataset, up to 2000 characters long, in the format bq://projectId.bqDatasetId
- schema
Config Property Map - The configuration for the exported BigQuery schema. Structure is documented below.
FhirStoreStreamConfigBigqueryDestinationSchemaConfig, FhirStoreStreamConfigBigqueryDestinationSchemaConfigArgs
- Recursive
Structure intDepth - The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
- Last
Updated FhirPartition Config Store Stream Config Bigquery Destination Schema Config Last Updated Partition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. Structure is documented below.
- Schema
Type string - Specifies the output schema type.
- ANALYTICS: Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
- ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
- LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
Default value is
ANALYTICS
. Possible values are:ANALYTICS
,ANALYTICS_V2
,LOSSLESS
.
- Recursive
Structure intDepth - The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
- Last
Updated FhirPartition Config Store Stream Config Bigquery Destination Schema Config Last Updated Partition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. Structure is documented below.
- Schema
Type string - Specifies the output schema type.
- ANALYTICS: Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
- ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
- LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
Default value is
ANALYTICS
. Possible values are:ANALYTICS
,ANALYTICS_V2
,LOSSLESS
.
- recursive
Structure IntegerDepth - The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
- last
Updated FhirPartition Config Store Stream Config Bigquery Destination Schema Config Last Updated Partition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. Structure is documented below.
- schema
Type String - Specifies the output schema type.
- ANALYTICS: Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
- ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
- LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
Default value is
ANALYTICS
. Possible values are:ANALYTICS
,ANALYTICS_V2
,LOSSLESS
.
- recursive
Structure numberDepth - The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
- last
Updated FhirPartition Config Store Stream Config Bigquery Destination Schema Config Last Updated Partition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. Structure is documented below.
- schema
Type string - Specifies the output schema type.
- ANALYTICS: Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
- ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
- LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
Default value is
ANALYTICS
. Possible values are:ANALYTICS
,ANALYTICS_V2
,LOSSLESS
.
- recursive_
structure_ intdepth - The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
- last_
updated_ Fhirpartition_ config Store Stream Config Bigquery Destination Schema Config Last Updated Partition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. Structure is documented below.
- schema_
type str - Specifies the output schema type.
- ANALYTICS: Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
- ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
- LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
Default value is
ANALYTICS
. Possible values are:ANALYTICS
,ANALYTICS_V2
,LOSSLESS
.
- recursive
Structure NumberDepth - The depth for all recursive structures in the output analytics schema. For example, concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5.
- last
Updated Property MapPartition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. Structure is documented below.
- schema
Type String - Specifies the output schema type.
- ANALYTICS: Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
- ANALYTICS_V2: Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON.
- LOSSLESS: A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification.
Default value is
ANALYTICS
. Possible values are:ANALYTICS
,ANALYTICS_V2
,LOSSLESS
.
FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfig, FhirStoreStreamConfigBigqueryDestinationSchemaConfigLastUpdatedPartitionConfigArgs
- Type string
- Type of partitioning.
Possible values are:
PARTITION_TYPE_UNSPECIFIED
,HOUR
,DAY
,MONTH
,YEAR
. - Expiration
Ms string - Number of milliseconds for which to keep the storage for a partition.
- Type string
- Type of partitioning.
Possible values are:
PARTITION_TYPE_UNSPECIFIED
,HOUR
,DAY
,MONTH
,YEAR
. - Expiration
Ms string - Number of milliseconds for which to keep the storage for a partition.
- type String
- Type of partitioning.
Possible values are:
PARTITION_TYPE_UNSPECIFIED
,HOUR
,DAY
,MONTH
,YEAR
. - expiration
Ms String - Number of milliseconds for which to keep the storage for a partition.
- type string
- Type of partitioning.
Possible values are:
PARTITION_TYPE_UNSPECIFIED
,HOUR
,DAY
,MONTH
,YEAR
. - expiration
Ms string - Number of milliseconds for which to keep the storage for a partition.
- type str
- Type of partitioning.
Possible values are:
PARTITION_TYPE_UNSPECIFIED
,HOUR
,DAY
,MONTH
,YEAR
. - expiration_
ms str - Number of milliseconds for which to keep the storage for a partition.
- type String
- Type of partitioning.
Possible values are:
PARTITION_TYPE_UNSPECIFIED
,HOUR
,DAY
,MONTH
,YEAR
. - expiration
Ms String - Number of milliseconds for which to keep the storage for a partition.
Import
FhirStore can be imported using any of these accepted formats:
{{dataset}}/fhirStores/{{name}}
{{dataset}}/{{name}}
When using the pulumi import
command, FhirStore can be imported using one of the formats above. For example:
$ pulumi import gcp:healthcare/fhirStore:FhirStore default {{dataset}}/fhirStores/{{name}}
$ pulumi import gcp:healthcare/fhirStore:FhirStore default {{dataset}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.