Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.healthcare/v1beta1.getFhirStore
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets the configuration of the specified FHIR store.
Using getFhirStore
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getFhirStore(args: GetFhirStoreArgs, opts?: InvokeOptions): Promise<GetFhirStoreResult>
function getFhirStoreOutput(args: GetFhirStoreOutputArgs, opts?: InvokeOptions): Output<GetFhirStoreResult>
def get_fhir_store(dataset_id: Optional[str] = None,
fhir_store_id: Optional[str] = None,
location: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetFhirStoreResult
def get_fhir_store_output(dataset_id: Optional[pulumi.Input[str]] = None,
fhir_store_id: Optional[pulumi.Input[str]] = None,
location: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetFhirStoreResult]
func LookupFhirStore(ctx *Context, args *LookupFhirStoreArgs, opts ...InvokeOption) (*LookupFhirStoreResult, error)
func LookupFhirStoreOutput(ctx *Context, args *LookupFhirStoreOutputArgs, opts ...InvokeOption) LookupFhirStoreResultOutput
> Note: This function is named LookupFhirStore
in the Go SDK.
public static class GetFhirStore
{
public static Task<GetFhirStoreResult> InvokeAsync(GetFhirStoreArgs args, InvokeOptions? opts = null)
public static Output<GetFhirStoreResult> Invoke(GetFhirStoreInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFhirStoreResult> getFhirStore(GetFhirStoreArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:healthcare/v1beta1:getFhirStore
arguments:
# arguments dictionary
The following arguments are supported:
- Dataset
Id string - Fhir
Store stringId - Location string
- Project string
- Dataset
Id string - Fhir
Store stringId - Location string
- Project string
- dataset
Id String - fhir
Store StringId - location String
- project String
- dataset
Id string - fhir
Store stringId - location string
- project string
- dataset_
id str - fhir_
store_ strid - location str
- project str
- dataset
Id String - fhir
Store StringId - location String
- project String
getFhirStore Result
The following output properties are available:
- 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 after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
- Consent
Config Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Consent Config Response - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- 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 defaulthandling=lenient
which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP headerPrefer: handling=strict
orPrefer: handling=lenient
. - Disable
Referential boolIntegrity - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
- Disable
Resource boolVersioning - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
- 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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
- 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}{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.
- Name string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. - Notification
Config Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Notification Config Response - Deprecated. Use
notification_configs
instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". - Notification
Configs List<Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Fhir Notification Config Response> - Specifies where and whether to send notifications upon changes to a Fhir store.
- Search
Config Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Search Config Response - Configuration for how FHIR resources can be searched.
- Stream
Configs List<Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Stream Config Response> - 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. - Validation
Config Pulumi.Google Native. Healthcare. V1Beta1. Outputs. Validation Config Response - Configuration for how to validate incoming FHIR resources against configured profiles.
- Version string
- Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
- 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 after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
- Consent
Config ConsentConfig Response - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- 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 defaulthandling=lenient
which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP headerPrefer: handling=strict
orPrefer: handling=lenient
. - Disable
Referential boolIntegrity - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
- Disable
Resource boolVersioning - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
- 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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
- 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}{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.
- Name string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. - Notification
Config NotificationConfig Response - Deprecated. Use
notification_configs
instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". - Notification
Configs []FhirNotification Config Response - Specifies where and whether to send notifications upon changes to a Fhir store.
- Search
Config SearchConfig Response - Configuration for how FHIR resources can be searched.
- Stream
Configs []StreamConfig Response - 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. - Validation
Config ValidationConfig Response - Configuration for how to validate incoming FHIR resources against configured profiles.
- Version string
- Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
- 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 after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
- consent
Config ConsentConfig Response - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- 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 defaulthandling=lenient
which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP headerPrefer: handling=strict
orPrefer: handling=lenient
. - disable
Referential BooleanIntegrity - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
- disable
Resource BooleanVersioning - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
- 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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
- 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}{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.
- name String
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. - notification
Config NotificationConfig Response - Deprecated. Use
notification_configs
instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". - notification
Configs List<FhirNotification Config Response> - Specifies where and whether to send notifications upon changes to a Fhir store.
- search
Config SearchConfig Response - Configuration for how FHIR resources can be searched.
- stream
Configs List<StreamConfig Response> - 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. - validation
Config ValidationConfig Response - Configuration for how to validate incoming FHIR resources against configured profiles.
- version String
- Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
- 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 after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
- consent
Config ConsentConfig Response - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- 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 defaulthandling=lenient
which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP headerPrefer: handling=strict
orPrefer: handling=lenient
. - disable
Referential booleanIntegrity - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
- disable
Resource booleanVersioning - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
- 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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
- 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}{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.
- name string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. - notification
Config NotificationConfig Response - Deprecated. Use
notification_configs
instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". - notification
Configs FhirNotification Config Response[] - Specifies where and whether to send notifications upon changes to a Fhir store.
- search
Config SearchConfig Response - Configuration for how FHIR resources can be searched.
- stream
Configs StreamConfig Response[] - 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. - validation
Config ValidationConfig Response - Configuration for how to validate incoming FHIR resources against configured profiles.
- version string
- Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
- 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 after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
- consent_
config ConsentConfig Response - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- 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 defaulthandling=lenient
which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP headerPrefer: handling=strict
orPrefer: handling=lenient
. - disable_
referential_ boolintegrity - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
- disable_
resource_ boolversioning - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
- 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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
- 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}{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.
- name str
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. - notification_
config NotificationConfig Response - Deprecated. Use
notification_configs
instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". - notification_
configs Sequence[FhirNotification Config Response] - Specifies where and whether to send notifications upon changes to a Fhir store.
- search_
config SearchConfig Response - Configuration for how FHIR resources can be searched.
- stream_
configs Sequence[StreamConfig Response] - 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. - validation_
config ValidationConfig Response - Configuration for how to validate incoming FHIR resources against configured profiles.
- version str
- Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
- 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 after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources.
- consent
Config Property Map - Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- 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 defaulthandling=lenient
which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP headerPrefer: handling=strict
orPrefer: handling=lenient
. - disable
Referential BooleanIntegrity - Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist.
- disable
Resource BooleanVersioning - Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.
- 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 return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.
- 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}{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.
- name String
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
. - notification
Config Property Map - Deprecated. Use
notification_configs
instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource". - notification
Configs List<Property Map> - Specifies where and whether to send notifications upon changes to a Fhir store.
- search
Config Property Map - Configuration for how FHIR resources can be searched.
- 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. - validation
Config Property Map - Configuration for how to validate incoming FHIR resources against configured profiles.
- version String
- Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store.
Supporting Types
AccessDeterminationLogConfigResponse
- Log
Level string - Optional. Controls the amount of detail to include as part of the audit logs.
- Log
Level string - Optional. Controls the amount of detail to include as part of the audit logs.
- log
Level String - Optional. Controls the amount of detail to include as part of the audit logs.
- log
Level string - Optional. Controls the amount of detail to include as part of the audit logs.
- log_
level str - Optional. Controls the amount of detail to include as part of the audit logs.
- log
Level String - Optional. Controls the amount of detail to include as part of the audit logs.
ActionResponse
- Clean
Image Pulumi.Tag Google Native. Healthcare. V1Beta1. Inputs. Image Config Response - Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep
. Supported tags: PixelData - Clean
Text Pulumi.Tag Google Native. Healthcare. V1Beta1. Inputs. Clean Text Tag Response - Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- Delete
Tag Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Delete Tag Response - Delete tag.
- Keep
Tag Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Keep Tag Response - Keep tag unchanged.
- Queries List<string>
- Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN"
- Recurse
Tag Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Recurse Tag Response - Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ
- Regen
Uid Pulumi.Tag Google Native. Healthcare. V1Beta1. Inputs. Regen Uid Tag Response - Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI
- Remove
Tag Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Remove Tag Response - Replace with empty tag.
- Reset
Tag Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Reset Tag Response - Reset tag to a placeholder value.
- Clean
Image ImageTag Config Response - Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep
. Supported tags: PixelData - Clean
Text CleanTag Text Tag Response - Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- Delete
Tag DeleteTag Response - Delete tag.
- Keep
Tag KeepTag Response - Keep tag unchanged.
- Queries []string
- Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN"
- Recurse
Tag RecurseTag Response - Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ
- Regen
Uid RegenTag Uid Tag Response - Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI
- Remove
Tag RemoveTag Response - Replace with empty tag.
- Reset
Tag ResetTag Response - Reset tag to a placeholder value.
- clean
Image ImageTag Config Response - Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep
. Supported tags: PixelData - clean
Text CleanTag Text Tag Response - Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- delete
Tag DeleteTag Response - Delete tag.
- keep
Tag KeepTag Response - Keep tag unchanged.
- queries List<String>
- Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN"
- recurse
Tag RecurseTag Response - Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ
- regen
Uid RegenTag Uid Tag Response - Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI
- remove
Tag RemoveTag Response - Replace with empty tag.
- reset
Tag ResetTag Response - Reset tag to a placeholder value.
- clean
Image ImageTag Config Response - Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep
. Supported tags: PixelData - clean
Text CleanTag Text Tag Response - Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- delete
Tag DeleteTag Response - Delete tag.
- keep
Tag KeepTag Response - Keep tag unchanged.
- queries string[]
- Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN"
- recurse
Tag RecurseTag Response - Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ
- regen
Uid RegenTag Uid Tag Response - Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI
- remove
Tag RemoveTag Response - Replace with empty tag.
- reset
Tag ResetTag Response - Reset tag to a placeholder value.
- clean_
image_ Imagetag Config Response - Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep
. Supported tags: PixelData - clean_
text_ Cleantag Text Tag Response - Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- delete_
tag DeleteTag Response - Delete tag.
- keep_
tag KeepTag Response - Keep tag unchanged.
- queries Sequence[str]
- Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN"
- recurse_
tag RecurseTag Response - Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ
- regen_
uid_ Regentag Uid Tag Response - Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI
- remove_
tag RemoveTag Response - Replace with empty tag.
- reset_
tag ResetTag Response - Reset tag to a placeholder value.
- clean
Image Property MapTag - Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep
. Supported tags: PixelData - clean
Text Property MapTag - Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- delete
Tag Property Map - Delete tag.
- keep
Tag Property Map - Keep tag unchanged.
- queries List<String>
- Select all tags with the listed tag IDs, names, or Value Representations (VRs). Examples: ID: "00100010" Keyword: "PatientName" VR: "PN"
- recurse
Tag Property Map - Recursively apply DICOM de-id to tags nested in a sequence. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): SQ
- regen
Uid Property MapTag - Replace UID with a new generated UID. Supported [Value Representation] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): UI
- remove
Tag Property Map - Replace with empty tag.
- reset
Tag Property Map - Reset tag to a placeholder value.
AnnotationConfigResponse
- Annotation
Store stringName - The name of the annotation store, in the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. - Store
Quote bool - If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- Annotation
Store stringName - The name of the annotation store, in the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. - Store
Quote bool - If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation
Store StringName - The name of the annotation store, in the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. - store
Quote Boolean - If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation
Store stringName - The name of the annotation store, in the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. - store
Quote boolean - If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation_
store_ strname - The name of the annotation store, in the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. - store_
quote bool - If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation
Store StringName - The name of the annotation store, in the form
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}
). * The destination annotation store must be in the same project as the source data. De-identifying data across multiple projects is not supported. * The destination annotation store must exist when using DeidentifyDicomStore or DeidentifyFhirStore. DeidentifyDataset automatically creates the destination annotation store. - store
Quote Boolean - If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
CharacterMaskConfigResponse
- Masking
Character string - Character to mask the sensitive values. If not supplied, defaults to "*".
- Masking
Character string - Character to mask the sensitive values. If not supplied, defaults to "*".
- masking
Character String - Character to mask the sensitive values. If not supplied, defaults to "*".
- masking
Character string - Character to mask the sensitive values. If not supplied, defaults to "*".
- masking_
character str - Character to mask the sensitive values. If not supplied, defaults to "*".
- masking
Character String - Character to mask the sensitive values. If not supplied, defaults to "*".
ConsentConfigResponse
- Access
Determination Pulumi.Log Config Google Native. Healthcare. V1Beta1. Inputs. Access Determination Log Config Response - Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM
option is used. - Access
Enforced bool - Optional. If set to true, when accessing FHIR resources, the consent headers provided using SMART-on-FHIR will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
- Consent
Header Pulumi.Handling Google Native. Healthcare. V1Beta1. Inputs. Consent Header Handling Response - Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope
header. - Enforced
Admin List<string>Consents - The versioned names of the enforced admin Consent resource(s), in the format
projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}
. For FHIR stores withdisable_resource_versioning=true
, the format isprojects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}
. This field can only be updated using ApplyAdminConsents. - Version string
- Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.
- Access
Determination AccessLog Config Determination Log Config Response - Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM
option is used. - Access
Enforced bool - Optional. If set to true, when accessing FHIR resources, the consent headers provided using SMART-on-FHIR will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
- Consent
Header ConsentHandling Header Handling Response - Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope
header. - Enforced
Admin []stringConsents - The versioned names of the enforced admin Consent resource(s), in the format
projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}
. For FHIR stores withdisable_resource_versioning=true
, the format isprojects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}
. This field can only be updated using ApplyAdminConsents. - Version string
- Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.
- access
Determination AccessLog Config Determination Log Config Response - Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM
option is used. - access
Enforced Boolean - Optional. If set to true, when accessing FHIR resources, the consent headers provided using SMART-on-FHIR will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
- consent
Header ConsentHandling Header Handling Response - Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope
header. - enforced
Admin List<String>Consents - The versioned names of the enforced admin Consent resource(s), in the format
projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}
. For FHIR stores withdisable_resource_versioning=true
, the format isprojects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}
. This field can only be updated using ApplyAdminConsents. - version String
- Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.
- access
Determination AccessLog Config Determination Log Config Response - Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM
option is used. - access
Enforced boolean - Optional. If set to true, when accessing FHIR resources, the consent headers provided using SMART-on-FHIR will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
- consent
Header ConsentHandling Header Handling Response - Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope
header. - enforced
Admin string[]Consents - The versioned names of the enforced admin Consent resource(s), in the format
projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}
. For FHIR stores withdisable_resource_versioning=true
, the format isprojects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}
. This field can only be updated using ApplyAdminConsents. - version string
- Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.
- access_
determination_ Accesslog_ config Determination Log Config Response - Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM
option is used. - access_
enforced bool - Optional. If set to true, when accessing FHIR resources, the consent headers provided using SMART-on-FHIR will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
- consent_
header_ Consenthandling Header Handling Response - Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope
header. - enforced_
admin_ Sequence[str]consents - The versioned names of the enforced admin Consent resource(s), in the format
projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}
. For FHIR stores withdisable_resource_versioning=true
, the format isprojects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}
. This field can only be updated using ApplyAdminConsents. - version str
- Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.
- access
Determination Property MapLog Config - Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM
option is used. - access
Enforced Boolean - Optional. If set to true, when accessing FHIR resources, the consent headers provided using SMART-on-FHIR will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.
- consent
Header Property MapHandling - Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope
header. - enforced
Admin List<String>Consents - The versioned names of the enforced admin Consent resource(s), in the format
projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}
. For FHIR stores withdisable_resource_versioning=true
, the format isprojects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}
. This field can only be updated using ApplyAdminConsents. - version String
- Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version.
ConsentHeaderHandlingResponse
- Profile string
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE
option is used.
- Profile string
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE
option is used.
- profile String
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE
option is used.
- profile string
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE
option is used.
- profile str
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE
option is used.
- profile String
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE
option is used.
CryptoHashConfigResponse
- Crypto
Key string - An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set.
- Kms
Wrapped Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Kms Wrapped Crypto Key Response - KMS wrapped key. Must not be set if crypto_key is set.
- Crypto
Key string - An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set.
- Kms
Wrapped KmsWrapped Crypto Key Response - KMS wrapped key. Must not be set if crypto_key is set.
- crypto
Key String - An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set.
- kms
Wrapped KmsWrapped Crypto Key Response - KMS wrapped key. Must not be set if crypto_key is set.
- crypto
Key string - An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set.
- kms
Wrapped KmsWrapped Crypto Key Response - KMS wrapped key. Must not be set if crypto_key is set.
- crypto_
key str - An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set.
- kms_
wrapped KmsWrapped Crypto Key Response - KMS wrapped key. Must not be set if crypto_key is set.
- crypto
Key String - An AES 128/192/256 bit key. Causes the hash to be computed based on this key. A default key is generated for each Deidentify operation and is used when neither crypto_key nor kms_wrapped is specified. Must not be set if kms_wrapped is set.
- kms
Wrapped Property Map - KMS wrapped key. Must not be set if crypto_key is set.
DateShiftConfigResponse
- Crypto
Key string - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set.
- Kms
Wrapped Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Kms Wrapped Crypto Key Response - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set.
- Crypto
Key string - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set.
- Kms
Wrapped KmsWrapped Crypto Key Response - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set.
- crypto
Key String - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set.
- kms
Wrapped KmsWrapped Crypto Key Response - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set.
- crypto
Key string - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set.
- kms
Wrapped KmsWrapped Crypto Key Response - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set.
- crypto_
key str - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set.
- kms_
wrapped KmsWrapped Crypto Key Response - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set.
- crypto
Key String - An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If the patient ID is empty for a DICOM resource, the date shift is computed based on this key and the study instance UID. If crypto_key is not set, then kms_wrapped is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if kms_wrapped is set.
- kms
Wrapped Property Map - KMS wrapped key. If kms_wrapped is not set, then crypto_key is used to calculate the date shift. If neither is set, a default key is generated for each de-identify operation. Must not be set if crypto_key is set.
DeidentifiedStoreDestinationResponse
- Config
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Deidentify Config Response - The configuration to use when de-identifying resources that are added to this store.
- Store string
- The full resource name of a Cloud Healthcare FHIR store, for example,
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
- Config
Deidentify
Config Response - The configuration to use when de-identifying resources that are added to this store.
- Store string
- The full resource name of a Cloud Healthcare FHIR store, for example,
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
- config
Deidentify
Config Response - The configuration to use when de-identifying resources that are added to this store.
- store String
- The full resource name of a Cloud Healthcare FHIR store, for example,
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
- config
Deidentify
Config Response - The configuration to use when de-identifying resources that are added to this store.
- store string
- The full resource name of a Cloud Healthcare FHIR store, for example,
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
- config
Deidentify
Config Response - The configuration to use when de-identifying resources that are added to this store.
- store str
- The full resource name of a Cloud Healthcare FHIR store, for example,
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
- config Property Map
- The configuration to use when de-identifying resources that are added to this store.
- store String
- The full resource name of a Cloud Healthcare FHIR store, for example,
projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}
.
DeidentifyConfigResponse
- Annotation
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Annotation Config Response - Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created.
- Dicom
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Dicom Config Response - Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config
instead. - Dicom
Tag Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Dicom Tag Config Response - Configures de-id of application/DICOM content.
- Fhir
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Fhir Config Response - Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config
instead. - Fhir
Field Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Fhir Field Config Response - Configures de-id of application/FHIR content.
- Image
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Image Config Response - Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image
instead. - Operation
Metadata Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Deidentify Operation Metadata Response - Details about the work the de-identify operation performed.
- Text
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Text Config Response - Configures de-identification of text wherever it is found in the source_dataset.
- Use
Regional boolData Processing - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with
LOCATION
orORGANIZATION_NAME
infoTypes. If the deprecated DicomConfig or FhirConfig are used, thenLOCATION
must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- Annotation
Annotation
Config Response - Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created.
- Dicom
Dicom
Config Response - Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config
instead. - Dicom
Tag DicomConfig Tag Config Response - Configures de-id of application/DICOM content.
- Fhir
Fhir
Config Response - Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config
instead. - Fhir
Field FhirConfig Field Config Response - Configures de-id of application/FHIR content.
- Image
Image
Config Response - Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image
instead. - Operation
Metadata DeidentifyOperation Metadata Response - Details about the work the de-identify operation performed.
- Text
Text
Config Response - Configures de-identification of text wherever it is found in the source_dataset.
- Use
Regional boolData Processing - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with
LOCATION
orORGANIZATION_NAME
infoTypes. If the deprecated DicomConfig or FhirConfig are used, thenLOCATION
must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
Annotation
Config Response - Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created.
- dicom
Dicom
Config Response - Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config
instead. - dicom
Tag DicomConfig Tag Config Response - Configures de-id of application/DICOM content.
- fhir
Fhir
Config Response - Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config
instead. - fhir
Field FhirConfig Field Config Response - Configures de-id of application/FHIR content.
- image
Image
Config Response - Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image
instead. - operation
Metadata DeidentifyOperation Metadata Response - Details about the work the de-identify operation performed.
- text
Text
Config Response - Configures de-identification of text wherever it is found in the source_dataset.
- use
Regional BooleanData Processing - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with
LOCATION
orORGANIZATION_NAME
infoTypes. If the deprecated DicomConfig or FhirConfig are used, thenLOCATION
must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
Annotation
Config Response - Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created.
- dicom
Dicom
Config Response - Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config
instead. - dicom
Tag DicomConfig Tag Config Response - Configures de-id of application/DICOM content.
- fhir
Fhir
Config Response - Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config
instead. - fhir
Field FhirConfig Field Config Response - Configures de-id of application/FHIR content.
- image
Image
Config Response - Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image
instead. - operation
Metadata DeidentifyOperation Metadata Response - Details about the work the de-identify operation performed.
- text
Text
Config Response - Configures de-identification of text wherever it is found in the source_dataset.
- use
Regional booleanData Processing - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with
LOCATION
orORGANIZATION_NAME
infoTypes. If the deprecated DicomConfig or FhirConfig are used, thenLOCATION
must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
Annotation
Config Response - Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created.
- dicom
Dicom
Config Response - Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config
instead. - dicom_
tag_ Dicomconfig Tag Config Response - Configures de-id of application/DICOM content.
- fhir
Fhir
Config Response - Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config
instead. - fhir_
field_ Fhirconfig Field Config Response - Configures de-id of application/FHIR content.
- image
Image
Config Response - Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image
instead. - operation_
metadata DeidentifyOperation Metadata Response - Details about the work the de-identify operation performed.
- text
Text
Config Response - Configures de-identification of text wherever it is found in the source_dataset.
- use_
regional_ booldata_ processing - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with
LOCATION
orORGANIZATION_NAME
infoTypes. If the deprecated DicomConfig or FhirConfig are used, thenLOCATION
must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation Property Map
- Configures how annotations, meaning that the location and infoType of sensitive information findings, are created during de-identification. If unspecified, no annotations are created.
- dicom Property Map
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config
instead. - dicom
Tag Property MapConfig - Configures de-id of application/DICOM content.
- fhir Property Map
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config
instead. - fhir
Field Property MapConfig - Configures de-id of application/FHIR content.
- image Property Map
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image
instead. - operation
Metadata Property Map - Details about the work the de-identify operation performed.
- text Property Map
- Configures de-identification of text wherever it is found in the source_dataset.
- use
Regional BooleanData Processing - Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with
LOCATION
orORGANIZATION_NAME
infoTypes. If the deprecated DicomConfig or FhirConfig are used, thenLOCATION
must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
DeidentifyOperationMetadataResponse
- Fhir
Output Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Fhir Output Response - Details about the FHIR store to write the output to.
- Fhir
Output FhirOutput Response - Details about the FHIR store to write the output to.
- fhir
Output FhirOutput Response - Details about the FHIR store to write the output to.
- fhir
Output FhirOutput Response - Details about the FHIR store to write the output to.
- fhir_
output FhirOutput Response - Details about the FHIR store to write the output to.
- fhir
Output Property Map - Details about the FHIR store to write the output to.
DicomConfigResponse
- Filter
Profile string - Tag filtering profile that determines which tags to keep/remove.
- Keep
List Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Tag Filter List Response - List of tags to keep. Remove all other tags.
- Remove
List Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Tag Filter List Response - List of tags to remove. Keep all other tags.
- Skip
Id boolRedaction - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
- Filter
Profile string - Tag filtering profile that determines which tags to keep/remove.
- Keep
List TagFilter List Response - List of tags to keep. Remove all other tags.
- Remove
List TagFilter List Response - List of tags to remove. Keep all other tags.
- Skip
Id boolRedaction - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
- filter
Profile String - Tag filtering profile that determines which tags to keep/remove.
- keep
List TagFilter List Response - List of tags to keep. Remove all other tags.
- remove
List TagFilter List Response - List of tags to remove. Keep all other tags.
- skip
Id BooleanRedaction - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
- filter
Profile string - Tag filtering profile that determines which tags to keep/remove.
- keep
List TagFilter List Response - List of tags to keep. Remove all other tags.
- remove
List TagFilter List Response - List of tags to remove. Keep all other tags.
- skip
Id booleanRedaction - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
- filter_
profile str - Tag filtering profile that determines which tags to keep/remove.
- keep_
list TagFilter List Response - List of tags to keep. Remove all other tags.
- remove_
list TagFilter List Response - List of tags to remove. Keep all other tags.
- skip_
id_ boolredaction - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
- filter
Profile String - Tag filtering profile that determines which tags to keep/remove.
- keep
List Property Map - List of tags to keep. Remove all other tags.
- remove
List Property Map - List of tags to remove. Keep all other tags.
- skip
Id BooleanRedaction - If true, skip replacing StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and leave them untouched. The Cloud Healthcare API regenerates these UIDs by default based on the DICOM Standard's reasoning: "Whilst these UIDs cannot be mapped directly to an individual out of context, given access to the original images, or to a database of the original images containing the UIDs, it would be possible to recover the individual's identity." http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
DicomTagConfigResponse
- Actions
List<Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Action Response> - Specifies custom tag selections and
Actions
to apply to them. Overridesoptions
andprofile
. ConflictingActions
are applied in the order given. - Options
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Options Response - Specifies additional options to apply, overriding the base
profile
. - Profile
Type string - Base profile type for handling DICOM tags.
- Actions
[]Action
Response - Specifies custom tag selections and
Actions
to apply to them. Overridesoptions
andprofile
. ConflictingActions
are applied in the order given. - Options
Options
Response - Specifies additional options to apply, overriding the base
profile
. - Profile
Type string - Base profile type for handling DICOM tags.
- actions
List<Action
Response> - Specifies custom tag selections and
Actions
to apply to them. Overridesoptions
andprofile
. ConflictingActions
are applied in the order given. - options
Options
Response - Specifies additional options to apply, overriding the base
profile
. - profile
Type String - Base profile type for handling DICOM tags.
- actions
Action
Response[] - Specifies custom tag selections and
Actions
to apply to them. Overridesoptions
andprofile
. ConflictingActions
are applied in the order given. - options
Options
Response - Specifies additional options to apply, overriding the base
profile
. - profile
Type string - Base profile type for handling DICOM tags.
- actions
Sequence[Action
Response] - Specifies custom tag selections and
Actions
to apply to them. Overridesoptions
andprofile
. ConflictingActions
are applied in the order given. - options
Options
Response - Specifies additional options to apply, overriding the base
profile
. - profile_
type str - Base profile type for handling DICOM tags.
- actions List<Property Map>
- Specifies custom tag selections and
Actions
to apply to them. Overridesoptions
andprofile
. ConflictingActions
are applied in the order given. - options Property Map
- Specifies additional options to apply, overriding the base
profile
. - profile
Type String - Base profile type for handling DICOM tags.
FhirConfigResponse
- Default
Keep boolExtensions - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
- Field
Metadata List<Pulumi.List Google Native. Healthcare. V1Beta1. Inputs. Field Metadata Response> - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to
default_keep_extensions
. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied.
- Default
Keep boolExtensions - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
- Field
Metadata []FieldList Metadata Response - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to
default_keep_extensions
. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied.
- default
Keep BooleanExtensions - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
- field
Metadata List<FieldList Metadata Response> - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to
default_keep_extensions
. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied.
- default
Keep booleanExtensions - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
- field
Metadata FieldList Metadata Response[] - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to
default_keep_extensions
. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied.
- default_
keep_ boolextensions - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
- field_
metadata_ Sequence[Fieldlist Metadata Response] - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to
default_keep_extensions
. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied.
- default
Keep BooleanExtensions - The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If true, all extensions are preserved during de-identification by default. If false or unspecified, all extensions are removed during de-identification by default.
- field
Metadata List<Property Map>List - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions will be processed according to
default_keep_extensions
. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied.
FhirFieldConfigResponse
- Field
Metadata List<Pulumi.List Google Native. Healthcare. V1Beta1. Inputs. Google Cloud Healthcare V1beta1Deidentify Field Metadata Response> - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata
action
is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadataaction
, the firstaction
option is applied. Overrides options and the union fieldprofile
in FhirFieldConfig. - Options
Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Google Cloud Healthcare V1beta1Deidentify Options Response - Specifies additional options, overriding the base ProfileType.
- Profile
Type string - Base profile type for handling FHIR fields.
- Field
Metadata []GoogleList Cloud Healthcare V1beta1Deidentify Field Metadata Response - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata
action
is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadataaction
, the firstaction
option is applied. Overrides options and the union fieldprofile
in FhirFieldConfig. - Options
Google
Cloud Healthcare V1beta1Deidentify Options Response - Specifies additional options, overriding the base ProfileType.
- Profile
Type string - Base profile type for handling FHIR fields.
- field
Metadata List<GoogleList Cloud Healthcare V1beta1Deidentify Field Metadata Response> - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata
action
is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadataaction
, the firstaction
option is applied. Overrides options and the union fieldprofile
in FhirFieldConfig. - options
Google
Cloud Healthcare V1beta1Deidentify Options Response - Specifies additional options, overriding the base ProfileType.
- profile
Type String - Base profile type for handling FHIR fields.
- field
Metadata GoogleList Cloud Healthcare V1beta1Deidentify Field Metadata Response[] - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata
action
is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadataaction
, the firstaction
option is applied. Overrides options and the union fieldprofile
in FhirFieldConfig. - options
Google
Cloud Healthcare V1beta1Deidentify Options Response - Specifies additional options, overriding the base ProfileType.
- profile
Type string - Base profile type for handling FHIR fields.
- field_
metadata_ Sequence[Googlelist Cloud Healthcare V1beta1Deidentify Field Metadata Response] - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata
action
is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadataaction
, the firstaction
option is applied. Overrides options and the union fieldprofile
in FhirFieldConfig. - options
Google
Cloud Healthcare V1beta1Deidentify Options Response - Specifies additional options, overriding the base ProfileType.
- profile_
type str - Base profile type for handling FHIR fields.
- field
Metadata List<Property Map>List - Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata
action
is passed through to the output dataset unmodified. All extensions will be processed according to keep_extensions. If a field can be matched by more than one FieldMetadataaction
, the firstaction
option is applied. Overrides options and the union fieldprofile
in FhirFieldConfig. - options Property Map
- Specifies additional options, overriding the base ProfileType.
- profile
Type String - Base profile type for handling FHIR fields.
FhirNotificationConfigResponse
- Pubsub
Topic string - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
PubsubMessage
with the following fields: *PubsubMessage.Data
contains the resource name. *PubsubMessage.MessageId
is the ID of this notification. It is guaranteed to be unique within the topic. *PubsubMessage.PublishTime
is the time when the message was published. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. - 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 Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
PubsubMessage
with the following fields: *PubsubMessage.Data
contains the resource name. *PubsubMessage.MessageId
is the ID of this notification. It is guaranteed to be unique within the topic. *PubsubMessage.PublishTime
is the time when the message was published. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. - 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 Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
PubsubMessage
with the following fields: *PubsubMessage.Data
contains the resource name. *PubsubMessage.MessageId
is the ID of this notification. It is guaranteed to be unique within the topic. *PubsubMessage.PublishTime
is the time when the message was published. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. - 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 Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
PubsubMessage
with the following fields: *PubsubMessage.Data
contains the resource name. *PubsubMessage.MessageId
is the ID of this notification. It is guaranteed to be unique within the topic. *PubsubMessage.PublishTime
is the time when the message was published. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. - 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 Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
PubsubMessage
with the following fields: *PubsubMessage.Data
contains the resource name. *PubsubMessage.MessageId
is the ID of this notification. It is guaranteed to be unique within the topic. *PubsubMessage.PublishTime
is the time when the message was published. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. - 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 Pub/Sub topic that notifications of changes are published on. Supplied by the client. The notification is a
PubsubMessage
with the following fields: *PubsubMessage.Data
contains the resource name. *PubsubMessage.MessageId
is the ID of this notification. It is guaranteed to be unique within the topic. *PubsubMessage.PublishTime
is the time when the message was published. Note that notifications are only sent if the topic is non-empty. Topic names must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging. - 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.
FhirOutputResponse
- Fhir
Store string - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.
- Fhir
Store string - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.
- fhir
Store String - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.
- fhir
Store string - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.
- fhir_
store str - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.
- fhir
Store String - Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.
FieldMetadataResponse
- Action string
- Deidentify action for one field.
- Paths List<string>
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.
- Action string
- Deidentify action for one field.
- Paths []string
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.
- action String
- Deidentify action for one field.
- paths List<String>
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.
- action string
- Deidentify action for one field.
- paths string[]
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.
- action str
- Deidentify action for one field.
- paths Sequence[str]
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.
- action String
- Deidentify action for one field.
- paths List<String>
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined. For example, "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted.
GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataResponse
- Character
Mask Pulumi.Field Google Native. Healthcare. V1Beta1. Inputs. Character Mask Field Response - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- Clean
Text Pulumi.Field Google Native. Healthcare. V1Beta1. Inputs. Clean Text Field Response - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- Crypto
Hash Pulumi.Field Google Native. Healthcare. V1Beta1. Inputs. Crypto Hash Field Response - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- Date
Shift Pulumi.Field Google Native. Healthcare. V1Beta1. Inputs. Date Shift Field Response - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- Keep
Field Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Keep Field Response - Keep the field unchanged.
- Paths List<string>
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field
Patient.Address.city
, which uses a string type, can be matched byPatient.Address.String
. Partial matching is supported. For example,Patient.Address.city
can be matched byAddress.city
(withPatient
omitted). Partial matching and type matching can be combined, for examplePatient.Address.city
can be matched byAddress.String
. For "choice" types (those defined in the FHIR spec with the formatfield[x]
), use two separate components. For example,deceasedAge.unit
is matched byDeceased.Age.unit
. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for exampleHumanName.given
,HumanName.family
) can be omitted. - Remove
Field Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Remove Field Response - Remove the field.
- Character
Mask CharacterField Mask Field Response - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- Clean
Text CleanField Text Field Response - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- Crypto
Hash CryptoField Hash Field Response - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- Date
Shift DateField Shift Field Response - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- Keep
Field KeepField Response - Keep the field unchanged.
- Paths []string
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field
Patient.Address.city
, which uses a string type, can be matched byPatient.Address.String
. Partial matching is supported. For example,Patient.Address.city
can be matched byAddress.city
(withPatient
omitted). Partial matching and type matching can be combined, for examplePatient.Address.city
can be matched byAddress.String
. For "choice" types (those defined in the FHIR spec with the formatfield[x]
), use two separate components. For example,deceasedAge.unit
is matched byDeceased.Age.unit
. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for exampleHumanName.given
,HumanName.family
) can be omitted. - Remove
Field RemoveField Response - Remove the field.
- character
Mask CharacterField Mask Field Response - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean
Text CleanField Text Field Response - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- crypto
Hash CryptoField Hash Field Response - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date
Shift DateField Shift Field Response - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep
Field KeepField Response - Keep the field unchanged.
- paths List<String>
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field
Patient.Address.city
, which uses a string type, can be matched byPatient.Address.String
. Partial matching is supported. For example,Patient.Address.city
can be matched byAddress.city
(withPatient
omitted). Partial matching and type matching can be combined, for examplePatient.Address.city
can be matched byAddress.String
. For "choice" types (those defined in the FHIR spec with the formatfield[x]
), use two separate components. For example,deceasedAge.unit
is matched byDeceased.Age.unit
. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for exampleHumanName.given
,HumanName.family
) can be omitted. - remove
Field RemoveField Response - Remove the field.
- character
Mask CharacterField Mask Field Response - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean
Text CleanField Text Field Response - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- crypto
Hash CryptoField Hash Field Response - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date
Shift DateField Shift Field Response - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep
Field KeepField Response - Keep the field unchanged.
- paths string[]
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field
Patient.Address.city
, which uses a string type, can be matched byPatient.Address.String
. Partial matching is supported. For example,Patient.Address.city
can be matched byAddress.city
(withPatient
omitted). Partial matching and type matching can be combined, for examplePatient.Address.city
can be matched byAddress.String
. For "choice" types (those defined in the FHIR spec with the formatfield[x]
), use two separate components. For example,deceasedAge.unit
is matched byDeceased.Age.unit
. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for exampleHumanName.given
,HumanName.family
) can be omitted. - remove
Field RemoveField Response - Remove the field.
- character_
mask_ Characterfield Mask Field Response - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean_
text_ Cleanfield Text Field Response - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- crypto_
hash_ Cryptofield Hash Field Response - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date_
shift_ Datefield Shift Field Response - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep_
field KeepField Response - Keep the field unchanged.
- paths Sequence[str]
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field
Patient.Address.city
, which uses a string type, can be matched byPatient.Address.String
. Partial matching is supported. For example,Patient.Address.city
can be matched byAddress.city
(withPatient
omitted). Partial matching and type matching can be combined, for examplePatient.Address.city
can be matched byAddress.String
. For "choice" types (those defined in the FHIR spec with the formatfield[x]
), use two separate components. For example,deceasedAge.unit
is matched byDeceased.Age.unit
. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for exampleHumanName.given
,HumanName.family
) can be omitted. - remove_
field RemoveField Response - Remove the field.
- character
Mask Property MapField - Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean
Text Property MapField - Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- crypto
Hash Property MapField - Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date
Shift Property MapField - Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep
Field Property Map - Keep the field unchanged.
- paths List<String>
- List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field
Patient.Address.city
, which uses a string type, can be matched byPatient.Address.String
. Partial matching is supported. For example,Patient.Address.city
can be matched byAddress.city
(withPatient
omitted). Partial matching and type matching can be combined, for examplePatient.Address.city
can be matched byAddress.String
. For "choice" types (those defined in the FHIR spec with the formatfield[x]
), use two separate components. For example,deceasedAge.unit
is matched byDeceased.Age.unit
. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for exampleHumanName.given
,HumanName.family
) can be omitted. - remove
Field Property Map - Remove the field.
GoogleCloudHealthcareV1beta1DeidentifyOptionsResponse
- Character
Mask Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Character Mask Config Response - Character mask config for CharacterMaskField.
- Contextual
Deid Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Contextual Deid Config Response - Configure contextual de-id.
- Crypto
Hash Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Crypto Hash Config Response - Crypto hash config for CharacterMaskField.
- Date
Shift Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Date Shift Config Response - Date shifting config for CharacterMaskField.
- Keep
Extensions Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Keep Extensions Config Response - Configure keeping extensions by default.
- Character
Mask CharacterConfig Mask Config Response - Character mask config for CharacterMaskField.
- Contextual
Deid ContextualDeid Config Response - Configure contextual de-id.
- Crypto
Hash CryptoConfig Hash Config Response - Crypto hash config for CharacterMaskField.
- Date
Shift DateConfig Shift Config Response - Date shifting config for CharacterMaskField.
- Keep
Extensions KeepExtensions Config Response - Configure keeping extensions by default.
- character
Mask CharacterConfig Mask Config Response - Character mask config for CharacterMaskField.
- contextual
Deid ContextualDeid Config Response - Configure contextual de-id.
- crypto
Hash CryptoConfig Hash Config Response - Crypto hash config for CharacterMaskField.
- date
Shift DateConfig Shift Config Response - Date shifting config for CharacterMaskField.
- keep
Extensions KeepExtensions Config Response - Configure keeping extensions by default.
- character
Mask CharacterConfig Mask Config Response - Character mask config for CharacterMaskField.
- contextual
Deid ContextualDeid Config Response - Configure contextual de-id.
- crypto
Hash CryptoConfig Hash Config Response - Crypto hash config for CharacterMaskField.
- date
Shift DateConfig Shift Config Response - Date shifting config for CharacterMaskField.
- keep
Extensions KeepExtensions Config Response - Configure keeping extensions by default.
- character_
mask_ Characterconfig Mask Config Response - Character mask config for CharacterMaskField.
- contextual_
deid ContextualDeid Config Response - Configure contextual de-id.
- crypto_
hash_ Cryptoconfig Hash Config Response - Crypto hash config for CharacterMaskField.
- date_
shift_ Dateconfig Shift Config Response - Date shifting config for CharacterMaskField.
- keep_
extensions KeepExtensions Config Response - Configure keeping extensions by default.
- character
Mask Property MapConfig - Character mask config for CharacterMaskField.
- contextual
Deid Property Map - Configure contextual de-id.
- crypto
Hash Property MapConfig - Crypto hash config for CharacterMaskField.
- date
Shift Property MapConfig - Date shifting config for CharacterMaskField.
- keep
Extensions Property Map - Configure keeping extensions by default.
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
- Dataset
Uri string - BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId
. - Force bool
- Use
write_disposition
instead. Ifwrite_disposition
is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - Schema
Config Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Schema Config Response - The configuration for the exported BigQuery schema.
- Write
Disposition string - Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the
force
parameter is ignored.
- Dataset
Uri string - BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId
. - Force bool
- Use
write_disposition
instead. Ifwrite_disposition
is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - Schema
Config SchemaConfig Response - The configuration for the exported BigQuery schema.
- Write
Disposition string - Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the
force
parameter is ignored.
- dataset
Uri String - BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId
. - force Boolean
- Use
write_disposition
instead. Ifwrite_disposition
is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - schema
Config SchemaConfig Response - The configuration for the exported BigQuery schema.
- write
Disposition String - Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the
force
parameter is ignored.
- dataset
Uri string - BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId
. - force boolean
- Use
write_disposition
instead. Ifwrite_disposition
is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - schema
Config SchemaConfig Response - The configuration for the exported BigQuery schema.
- write
Disposition string - Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the
force
parameter is ignored.
- dataset_
uri str - BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId
. - force bool
- Use
write_disposition
instead. Ifwrite_disposition
is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - schema_
config SchemaConfig Response - The configuration for the exported BigQuery schema.
- write_
disposition str - Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the
force
parameter is ignored.
- dataset
Uri String - BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId
. - force Boolean
- Use
write_disposition
instead. Ifwrite_disposition
is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - schema
Config Property Map - The configuration for the exported BigQuery schema.
- write
Disposition String - Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the
force
parameter is ignored.
ImageConfigResponse
- Additional
Info List<string>Types - Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
,REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
orTEXT_REDACTION_MODE_UNSPECIFIED
. - Exclude
Info List<string>Types - InfoTypes to skip redacting, overriding those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
orREDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
. - Text
Redaction stringMode - Determines how to redact text from image.
- Additional
Info []stringTypes - Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
,REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
orTEXT_REDACTION_MODE_UNSPECIFIED
. - Exclude
Info []stringTypes - InfoTypes to skip redacting, overriding those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
orREDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
. - Text
Redaction stringMode - Determines how to redact text from image.
- additional
Info List<String>Types - Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
,REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
orTEXT_REDACTION_MODE_UNSPECIFIED
. - exclude
Info List<String>Types - InfoTypes to skip redacting, overriding those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
orREDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
. - text
Redaction StringMode - Determines how to redact text from image.
- additional
Info string[]Types - Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
,REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
orTEXT_REDACTION_MODE_UNSPECIFIED
. - exclude
Info string[]Types - InfoTypes to skip redacting, overriding those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
orREDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
. - text
Redaction stringMode - Determines how to redact text from image.
- additional_
info_ Sequence[str]types - Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
,REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
orTEXT_REDACTION_MODE_UNSPECIFIED
. - exclude_
info_ Sequence[str]types - InfoTypes to skip redacting, overriding those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
orREDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
. - text_
redaction_ strmode - Determines how to redact text from image.
- additional
Info List<String>Types - Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
,REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
orTEXT_REDACTION_MODE_UNSPECIFIED
. - exclude
Info List<String>Types - InfoTypes to skip redacting, overriding those used by
text_redaction_mode
. Can only be used whentext_redaction_mode
is set toREDACT_SENSITIVE_TEXT
orREDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS
. - text
Redaction StringMode - Determines how to redact text from image.
InfoTypeTransformationResponse
- Character
Mask Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Character Mask Config Response - Config for character mask.
- Crypto
Hash Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Crypto Hash Config Response - Config for crypto hash.
- Date
Shift Pulumi.Config Google Native. Healthcare. V1Beta1. Inputs. Date Shift Config Response - Config for date shift.
- Info
Types List<string> InfoTypes
to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for anyinfo_type
that is not specified in another transformation.- Redact
Config Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Redact Config Response - Config for text redaction.
- Replace
With Pulumi.Info Type Config Google Native. Healthcare. V1Beta1. Inputs. Replace With Info Type Config Response - Config for replace with InfoType.
- Character
Mask CharacterConfig Mask Config Response - Config for character mask.
- Crypto
Hash CryptoConfig Hash Config Response - Config for crypto hash.
- Date
Shift DateConfig Shift Config Response - Config for date shift.
- Info
Types []string InfoTypes
to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for anyinfo_type
that is not specified in another transformation.- Redact
Config RedactConfig Response - Config for text redaction.
- Replace
With ReplaceInfo Type Config With Info Type Config Response - Config for replace with InfoType.
- character
Mask CharacterConfig Mask Config Response - Config for character mask.
- crypto
Hash CryptoConfig Hash Config Response - Config for crypto hash.
- date
Shift DateConfig Shift Config Response - Config for date shift.
- info
Types List<String> InfoTypes
to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for anyinfo_type
that is not specified in another transformation.- redact
Config RedactConfig Response - Config for text redaction.
- replace
With ReplaceInfo Type Config With Info Type Config Response - Config for replace with InfoType.
- character
Mask CharacterConfig Mask Config Response - Config for character mask.
- crypto
Hash CryptoConfig Hash Config Response - Config for crypto hash.
- date
Shift DateConfig Shift Config Response - Config for date shift.
- info
Types string[] InfoTypes
to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for anyinfo_type
that is not specified in another transformation.- redact
Config RedactConfig Response - Config for text redaction.
- replace
With ReplaceInfo Type Config With Info Type Config Response - Config for replace with InfoType.
- character_
mask_ Characterconfig Mask Config Response - Config for character mask.
- crypto_
hash_ Cryptoconfig Hash Config Response - Config for crypto hash.
- date_
shift_ Dateconfig Shift Config Response - Config for date shift.
- info_
types Sequence[str] InfoTypes
to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for anyinfo_type
that is not specified in another transformation.- redact_
config RedactConfig Response - Config for text redaction.
- replace_
with_ Replaceinfo_ type_ config With Info Type Config Response - Config for replace with InfoType.
- character
Mask Property MapConfig - Config for character mask.
- crypto
Hash Property MapConfig - Config for crypto hash.
- date
Shift Property MapConfig - Config for date shift.
- info
Types List<String> InfoTypes
to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for anyinfo_type
that is not specified in another transformation.- redact
Config Property Map - Config for text redaction.
- replace
With Property MapInfo Type Config - Config for replace with InfoType.
KmsWrappedCryptoKeyResponse
- Crypto
Key string - The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}
. - Wrapped
Key string - The wrapped data crypto key.
- Crypto
Key string - The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}
. - Wrapped
Key string - The wrapped data crypto key.
- crypto
Key String - The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}
. - wrapped
Key String - The wrapped data crypto key.
- crypto
Key string - The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}
. - wrapped
Key string - The wrapped data crypto key.
- crypto_
key str - The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}
. - wrapped_
key str - The wrapped data crypto key.
- crypto
Key String - The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}
. - wrapped
Key String - The wrapped data crypto key.
NotificationConfigResponse
- Pubsub
Topic string - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
- Send
For boolBulk Import - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- Pubsub
Topic string - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
- Send
For boolBulk Import - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsub
Topic String - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
- send
For BooleanBulk Import - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsub
Topic string - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
- send
For booleanBulk Import - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsub_
topic str - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
- send_
for_ boolbulk_ import - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsub
Topic String - The Pub/Sub topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains 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. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see Configuring Pub/Sub notifications for specific details.
- send
For BooleanBulk Import - Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
OptionsResponse
- Clean
Descriptors Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Clean Descriptors Option Response - Set Clean Descriptors Option.
- Clean
Image Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Image Config Response - Apply
Action.clean_image
toPixelData
as configured. - Primary
Ids string - Set
Action
forStudyInstanceUID
,SeriesInstanceUID
,SOPInstanceUID
, andMediaStorageSOPInstanceUID
.
- Clean
Descriptors CleanDescriptors Option Response - Set Clean Descriptors Option.
- Clean
Image ImageConfig Response - Apply
Action.clean_image
toPixelData
as configured. - Primary
Ids string - Set
Action
forStudyInstanceUID
,SeriesInstanceUID
,SOPInstanceUID
, andMediaStorageSOPInstanceUID
.
- clean
Descriptors CleanDescriptors Option Response - Set Clean Descriptors Option.
- clean
Image ImageConfig Response - Apply
Action.clean_image
toPixelData
as configured. - primary
Ids String - Set
Action
forStudyInstanceUID
,SeriesInstanceUID
,SOPInstanceUID
, andMediaStorageSOPInstanceUID
.
- clean
Descriptors CleanDescriptors Option Response - Set Clean Descriptors Option.
- clean
Image ImageConfig Response - Apply
Action.clean_image
toPixelData
as configured. - primary
Ids string - Set
Action
forStudyInstanceUID
,SeriesInstanceUID
,SOPInstanceUID
, andMediaStorageSOPInstanceUID
.
- clean_
descriptors CleanDescriptors Option Response - Set Clean Descriptors Option.
- clean_
image ImageConfig Response - Apply
Action.clean_image
toPixelData
as configured. - primary_
ids str - Set
Action
forStudyInstanceUID
,SeriesInstanceUID
,SOPInstanceUID
, andMediaStorageSOPInstanceUID
.
- clean
Descriptors Property Map - Set Clean Descriptors Option.
- clean
Image Property Map - Apply
Action.clean_image
toPixelData
as configured. - primary
Ids String - Set
Action
forStudyInstanceUID
,SeriesInstanceUID
,SOPInstanceUID
, andMediaStorageSOPInstanceUID
.
SchemaConfigResponse
- Last
Updated Pulumi.Partition Config Google Native. Healthcare. V1Beta1. Inputs. Time Partitioning Response - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- Recursive
Structure stringDepth - 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 calledconcept.concept
but notconcept.concept.concept
. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - Schema
Type string - Specifies the output schema type. Schema type is required.
- Last
Updated TimePartition Config Partitioning Response - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- Recursive
Structure stringDepth - 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 calledconcept.concept
but notconcept.concept.concept
. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - Schema
Type string - Specifies the output schema type. Schema type is required.
- last
Updated TimePartition Config Partitioning Response - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive
Structure StringDepth - 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 calledconcept.concept
but notconcept.concept.concept
. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema
Type String - Specifies the output schema type. Schema type is required.
- last
Updated TimePartition Config Partitioning Response - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive
Structure stringDepth - 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 calledconcept.concept
but notconcept.concept.concept
. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema
Type string - Specifies the output schema type. Schema type is required.
- last_
updated_ Timepartition_ config Partitioning Response - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive_
structure_ strdepth - 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 calledconcept.concept
but notconcept.concept.concept
. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema_
type str - Specifies the output schema type. Schema type is required.
- last
Updated Property MapPartition Config - The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive
Structure StringDepth - 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 calledconcept.concept
but notconcept.concept.concept
. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema
Type String - Specifies the output schema type. Schema type is required.
SearchConfigResponse
- Search
Parameters List<Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Search Parameter Response> - A list of search parameters in this FHIR store that are used to configure this FHIR store.
- Search
Parameters []SearchParameter Response - A list of search parameters in this FHIR store that are used to configure this FHIR store.
- search
Parameters List<SearchParameter Response> - A list of search parameters in this FHIR store that are used to configure this FHIR store.
- search
Parameters SearchParameter Response[] - A list of search parameters in this FHIR store that are used to configure this FHIR store.
- search_
parameters Sequence[SearchParameter Response] - A list of search parameters in this FHIR store that are used to configure this FHIR store.
- search
Parameters List<Property Map> - A list of search parameters in this FHIR store that are used to configure this FHIR store.
SearchParameterResponse
- Canonical
Url string - The canonical url of the search parameter resource.
- Parameter string
- The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
- Canonical
Url string - The canonical url of the search parameter resource.
- Parameter string
- The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
- canonical
Url String - The canonical url of the search parameter resource.
- parameter String
- The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
- canonical
Url string - The canonical url of the search parameter resource.
- parameter string
- The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
- canonical_
url str - The canonical url of the search parameter resource.
- parameter str
- The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
- canonical
Url String - The canonical url of the search parameter resource.
- parameter String
- The versioned name of the search parameter resource. The format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{version-id} For fhir stores with disable_resource_versioning=true, the format is projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirStores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
StreamConfigResponse
- Bigquery
Destination Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Google Cloud Healthcare V1beta1Fhir Big Query Destination Response - 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. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- Deidentified
Store Pulumi.Destination Google Native. Healthcare. V1Beta1. Inputs. Deidentified Store Destination Response - The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- 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 GoogleCloud Healthcare V1beta1Fhir Big Query Destination Response - 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. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- Deidentified
Store DeidentifiedDestination Store Destination Response - The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- 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 GoogleCloud Healthcare V1beta1Fhir Big Query Destination Response - 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. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- deidentified
Store DeidentifiedDestination Store Destination Response - The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- 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 GoogleCloud Healthcare V1beta1Fhir Big Query Destination Response - 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. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- deidentified
Store DeidentifiedDestination Store Destination Response - The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- 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 GoogleCloud Healthcare V1beta1Fhir Big Query Destination Response - 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. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- deidentified_
store_ Deidentifieddestination Store Destination Response - The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- 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. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data will not be streamed. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- deidentified
Store Property MapDestination - The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's Cloud Healthcare Service Agent service account. The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see Viewing error logs in Cloud Logging).
- 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.
TagFilterListResponse
- List<string>
- Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010".
- []string
- Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010".
- List<String>
- Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010".
- string[]
- Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010".
- Sequence[str]
- Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010".
- List<String>
- Tags to be filtered. Tags must be DICOM Data Elements, File Meta Elements, or Directory Structuring Elements, as defined at: http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,. They may be provided by "Keyword" or "Tag". For example, "PatientID", "00100010".
TextConfigResponse
- Additional
Transformations List<Pulumi.Google Native. Healthcare. V1Beta1. Inputs. Info Type Transformation Response> - Additional transformations to apply to the detected data, overriding
profile
. - Exclude
Info List<string>Types - InfoTypes to skip transforming, overriding
profile
. - Profile
Type string - Base profile type for text transformation.
- Transformations
List<Pulumi.
Google Native. Healthcare. V1Beta1. Inputs. Info Type Transformation Response> - The transformations to apply to the detected data. Deprecated. Use
additional_transformations
instead.
- Additional
Transformations []InfoType Transformation Response - Additional transformations to apply to the detected data, overriding
profile
. - Exclude
Info []stringTypes - InfoTypes to skip transforming, overriding
profile
. - Profile
Type string - Base profile type for text transformation.
- Transformations
[]Info
Type Transformation Response - The transformations to apply to the detected data. Deprecated. Use
additional_transformations
instead.
- additional
Transformations List<InfoType Transformation Response> - Additional transformations to apply to the detected data, overriding
profile
. - exclude
Info List<String>Types - InfoTypes to skip transforming, overriding
profile
. - profile
Type String - Base profile type for text transformation.
- transformations
List<Info
Type Transformation Response> - The transformations to apply to the detected data. Deprecated. Use
additional_transformations
instead.
- additional
Transformations InfoType Transformation Response[] - Additional transformations to apply to the detected data, overriding
profile
. - exclude
Info string[]Types - InfoTypes to skip transforming, overriding
profile
. - profile
Type string - Base profile type for text transformation.
- transformations
Info
Type Transformation Response[] - The transformations to apply to the detected data. Deprecated. Use
additional_transformations
instead.
- additional_
transformations Sequence[InfoType Transformation Response] - Additional transformations to apply to the detected data, overriding
profile
. - exclude_
info_ Sequence[str]types - InfoTypes to skip transforming, overriding
profile
. - profile_
type str - Base profile type for text transformation.
- transformations
Sequence[Info
Type Transformation Response] - The transformations to apply to the detected data. Deprecated. Use
additional_transformations
instead.
- additional
Transformations List<Property Map> - Additional transformations to apply to the detected data, overriding
profile
. - exclude
Info List<String>Types - InfoTypes to skip transforming, overriding
profile
. - profile
Type String - Base profile type for text transformation.
- transformations List<Property Map>
- The transformations to apply to the detected data. Deprecated. Use
additional_transformations
instead.
TimePartitioningResponse
- Expiration
Ms string - Number of milliseconds for which to keep the storage for a partition.
- Type string
- Type of partitioning.
- Expiration
Ms string - Number of milliseconds for which to keep the storage for a partition.
- Type string
- Type of partitioning.
- expiration
Ms String - Number of milliseconds for which to keep the storage for a partition.
- type String
- Type of partitioning.
- expiration
Ms string - Number of milliseconds for which to keep the storage for a partition.
- type string
- Type of partitioning.
- expiration_
ms str - Number of milliseconds for which to keep the storage for a partition.
- type str
- Type of partitioning.
- expiration
Ms String - Number of milliseconds for which to keep the storage for a partition.
- type String
- Type of partitioning.
ValidationConfigResponse
- Disable
Fhirpath boolValidation - Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- Disable
Profile boolValidation - Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
- Disable
Reference boolType Validation - Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- Disable
Required boolField Validation - Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- Enabled
Implementation List<string>Guides - A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set
enabled_implementation_guides
to["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]
. Ifenabled_implementation_guides
is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in theglobal
property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
- Disable
Fhirpath boolValidation - Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- Disable
Profile boolValidation - Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
- Disable
Reference boolType Validation - Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- Disable
Required boolField Validation - Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- Enabled
Implementation []stringGuides - A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set
enabled_implementation_guides
to["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]
. Ifenabled_implementation_guides
is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in theglobal
property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
- disable
Fhirpath BooleanValidation - Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable
Profile BooleanValidation - Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
- disable
Reference BooleanType Validation - Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable
Required BooleanField Validation - Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- enabled
Implementation List<String>Guides - A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set
enabled_implementation_guides
to["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]
. Ifenabled_implementation_guides
is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in theglobal
property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
- disable
Fhirpath booleanValidation - Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable
Profile booleanValidation - Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
- disable
Reference booleanType Validation - Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable
Required booleanField Validation - Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- enabled
Implementation string[]Guides - A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set
enabled_implementation_guides
to["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]
. Ifenabled_implementation_guides
is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in theglobal
property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
- disable_
fhirpath_ boolvalidation - Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable_
profile_ boolvalidation - Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
- disable_
reference_ booltype_ validation - Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable_
required_ boolfield_ validation - Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- enabled_
implementation_ Sequence[str]guides - A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set
enabled_implementation_guides
to["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]
. Ifenabled_implementation_guides
is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in theglobal
property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
- disable
Fhirpath BooleanValidation - Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable
Profile BooleanValidation - Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.
- disable
Reference BooleanType Validation - Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- disable
Required BooleanField Validation - Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.
- enabled
Implementation List<String>Guides - A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set
enabled_implementation_guides
to["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]
. Ifenabled_implementation_guides
is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in theglobal
property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi