Creates a new FHIR store within the parent dataset.
Auto-naming is currently not supported for this resource.
Create FhirStore Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def FhirStore(resource_name: str,
args: FhirStoreArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FhirStore(resource_name: str,
opts: Optional[ResourceOptions] = None,
dataset_id: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
notification_config: Optional[NotificationConfigArgs] = None,
default_search_handling_strict: Optional[bool] = None,
disable_referential_integrity: Optional[bool] = None,
disable_resource_versioning: Optional[bool] = None,
enable_update_create: Optional[bool] = None,
consent_config: Optional[ConsentConfigArgs] = None,
fhir_store_id: Optional[str] = None,
location: Optional[str] = None,
complex_data_type_reference_parsing: Optional[FhirStoreComplexDataTypeReferenceParsing] = None,
notification_configs: Optional[Sequence[FhirNotificationConfigArgs]] = None,
project: Optional[str] = None,
search_config: Optional[SearchConfigArgs] = None,
stream_configs: Optional[Sequence[StreamConfigArgs]] = None,
validation_config: Optional[ValidationConfigArgs] = None,
version: Optional[FhirStoreVersion] = None)
public FhirStore(String name, FhirStoreArgs args)
public FhirStore(String name, FhirStoreArgs args, CustomResourceOptions options)
type: google-native:healthcare/v1beta1:FhirStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "google-native_healthcare_v1beta1_fhir_store" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
FhirStoreArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
FhirStoreArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
FhirStoreArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
FhirStoreArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
FhirStoreArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var google_nativeFhirStoreResource = new GoogleNative.Healthcare.V1Beta1.FhirStore("google-nativeFhirStoreResource", new()
{
DatasetId = "string",
Labels =
{
{ "string", "string" },
},
DefaultSearchHandlingStrict = false,
DisableReferentialIntegrity = false,
DisableResourceVersioning = false,
EnableUpdateCreate = false,
ConsentConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.ConsentConfigArgs
{
Version = GoogleNative.Healthcare.V1Beta1.ConsentConfigVersion.ConsentEnforcementVersionUnspecified,
AccessDeterminationLogConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.AccessDeterminationLogConfigArgs
{
LogLevel = GoogleNative.Healthcare.V1Beta1.AccessDeterminationLogConfigLogLevel.LogLevelUnspecified,
},
AccessEnforced = false,
ConsentHeaderHandling = new GoogleNative.Healthcare.V1Beta1.Inputs.ConsentHeaderHandlingArgs
{
Profile = GoogleNative.Healthcare.V1Beta1.ConsentHeaderHandlingProfile.ScopeProfileUnspecified,
},
EnforcedAdminConsents = new[]
{
"string",
},
},
FhirStoreId = "string",
Location = "string",
ComplexDataTypeReferenceParsing = GoogleNative.Healthcare.V1Beta1.FhirStoreComplexDataTypeReferenceParsing.ComplexDataTypeReferenceParsingUnspecified,
NotificationConfigs = new[]
{
new GoogleNative.Healthcare.V1Beta1.Inputs.FhirNotificationConfigArgs
{
PubsubTopic = "string",
SendFullResource = false,
SendPreviousResourceOnDelete = false,
},
},
Project = "string",
SearchConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.SearchConfigArgs
{
SearchParameters = new[]
{
new GoogleNative.Healthcare.V1Beta1.Inputs.SearchParameterArgs
{
CanonicalUrl = "string",
Parameter = "string",
},
},
},
StreamConfigs = new[]
{
new GoogleNative.Healthcare.V1Beta1.Inputs.StreamConfigArgs
{
BigqueryDestination = new GoogleNative.Healthcare.V1Beta1.Inputs.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationArgs
{
DatasetUri = "string",
Force = false,
SchemaConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.SchemaConfigArgs
{
LastUpdatedPartitionConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.TimePartitioningArgs
{
ExpirationMs = "string",
Type = GoogleNative.Healthcare.V1Beta1.TimePartitioningType.PartitionTypeUnspecified,
},
RecursiveStructureDepth = "string",
SchemaType = GoogleNative.Healthcare.V1Beta1.SchemaConfigSchemaType.SchemaTypeUnspecified,
},
WriteDisposition = GoogleNative.Healthcare.V1Beta1.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition.WriteDispositionUnspecified,
},
DeidentifiedStoreDestination = new GoogleNative.Healthcare.V1Beta1.Inputs.DeidentifiedStoreDestinationArgs
{
Config = new GoogleNative.Healthcare.V1Beta1.Inputs.DeidentifyConfigArgs
{
Annotation = new GoogleNative.Healthcare.V1Beta1.Inputs.AnnotationConfigArgs
{
AnnotationStoreName = "string",
StoreQuote = false,
},
DicomTagConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.DicomTagConfigArgs
{
Actions = new[]
{
new GoogleNative.Healthcare.V1Beta1.Inputs.ActionArgs
{
CleanImageTag = new GoogleNative.Healthcare.V1Beta1.Inputs.ImageConfigArgs
{
AdditionalInfoTypes = new[]
{
"string",
},
ExcludeInfoTypes = new[]
{
"string",
},
TextRedactionMode = GoogleNative.Healthcare.V1Beta1.ImageConfigTextRedactionMode.TextRedactionModeUnspecified,
},
CleanTextTag = null,
DeleteTag = null,
KeepTag = null,
Queries = new[]
{
"string",
},
RecurseTag = null,
RegenUidTag = null,
RemoveTag = null,
ResetTag = null,
},
},
Options = new GoogleNative.Healthcare.V1Beta1.Inputs.OptionsArgs
{
CleanDescriptors = null,
CleanImage = new GoogleNative.Healthcare.V1Beta1.Inputs.ImageConfigArgs
{
AdditionalInfoTypes = new[]
{
"string",
},
ExcludeInfoTypes = new[]
{
"string",
},
TextRedactionMode = GoogleNative.Healthcare.V1Beta1.ImageConfigTextRedactionMode.TextRedactionModeUnspecified,
},
PrimaryIds = GoogleNative.Healthcare.V1Beta1.OptionsPrimaryIds.PrimaryIdsOptionUnspecified,
},
ProfileType = GoogleNative.Healthcare.V1Beta1.DicomTagConfigProfileType.ProfileTypeUnspecified,
},
FhirFieldConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.FhirFieldConfigArgs
{
FieldMetadataList = new[]
{
new GoogleNative.Healthcare.V1Beta1.Inputs.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataArgs
{
CharacterMaskField = null,
CleanTextField = null,
CryptoHashField = null,
DateShiftField = null,
KeepField = null,
Paths = new[]
{
"string",
},
RemoveField = null,
},
},
Options = new GoogleNative.Healthcare.V1Beta1.Inputs.GoogleCloudHealthcareV1beta1DeidentifyOptionsArgs
{
CharacterMaskConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.CharacterMaskConfigArgs
{
MaskingCharacter = "string",
},
ContextualDeid = null,
CryptoHashConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.CryptoHashConfigArgs
{
CryptoKey = "string",
KmsWrapped = new GoogleNative.Healthcare.V1Beta1.Inputs.KmsWrappedCryptoKeyArgs
{
CryptoKey = "string",
WrappedKey = "string",
},
},
DateShiftConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.DateShiftConfigArgs
{
CryptoKey = "string",
KmsWrapped = new GoogleNative.Healthcare.V1Beta1.Inputs.KmsWrappedCryptoKeyArgs
{
CryptoKey = "string",
WrappedKey = "string",
},
},
KeepExtensions = null,
},
ProfileType = GoogleNative.Healthcare.V1Beta1.FhirFieldConfigProfileType.ProfileTypeUnspecified,
},
OperationMetadata = new GoogleNative.Healthcare.V1Beta1.Inputs.DeidentifyOperationMetadataArgs
{
FhirOutput = new GoogleNative.Healthcare.V1Beta1.Inputs.FhirOutputArgs
{
FhirStore = "string",
},
},
Text = new GoogleNative.Healthcare.V1Beta1.Inputs.TextConfigArgs
{
AdditionalTransformations = new[]
{
new GoogleNative.Healthcare.V1Beta1.Inputs.InfoTypeTransformationArgs
{
CharacterMaskConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.CharacterMaskConfigArgs
{
MaskingCharacter = "string",
},
CryptoHashConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.CryptoHashConfigArgs
{
CryptoKey = "string",
KmsWrapped = new GoogleNative.Healthcare.V1Beta1.Inputs.KmsWrappedCryptoKeyArgs
{
CryptoKey = "string",
WrappedKey = "string",
},
},
DateShiftConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.DateShiftConfigArgs
{
CryptoKey = "string",
KmsWrapped = new GoogleNative.Healthcare.V1Beta1.Inputs.KmsWrappedCryptoKeyArgs
{
CryptoKey = "string",
WrappedKey = "string",
},
},
InfoTypes = new[]
{
"string",
},
RedactConfig = null,
ReplaceWithInfoTypeConfig = null,
},
},
ExcludeInfoTypes = new[]
{
"string",
},
ProfileType = GoogleNative.Healthcare.V1Beta1.TextConfigProfileType.ProfileTypeUnspecified,
},
UseRegionalDataProcessing = false,
},
Store = "string",
},
ResourceTypes = new[]
{
"string",
},
},
},
ValidationConfig = new GoogleNative.Healthcare.V1Beta1.Inputs.ValidationConfigArgs
{
DisableFhirpathValidation = false,
DisableProfileValidation = false,
DisableReferenceTypeValidation = false,
DisableRequiredFieldValidation = false,
EnabledImplementationGuides = new[]
{
"string",
},
},
Version = GoogleNative.Healthcare.V1Beta1.FhirStoreVersion.VersionUnspecified,
});
example, err := healthcarev1beta1.NewFhirStore(ctx, "google-nativeFhirStoreResource", &healthcarev1beta1.FhirStoreArgs{
DatasetId: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
DefaultSearchHandlingStrict: pulumi.Bool(false),
DisableReferentialIntegrity: pulumi.Bool(false),
DisableResourceVersioning: pulumi.Bool(false),
EnableUpdateCreate: pulumi.Bool(false),
ConsentConfig: &healthcare.ConsentConfigArgs{
Version: healthcarev1beta1.ConsentConfigVersionConsentEnforcementVersionUnspecified,
AccessDeterminationLogConfig: &healthcare.AccessDeterminationLogConfigArgs{
LogLevel: healthcarev1beta1.AccessDeterminationLogConfigLogLevelLogLevelUnspecified,
},
AccessEnforced: pulumi.Bool(false),
ConsentHeaderHandling: &healthcare.ConsentHeaderHandlingArgs{
Profile: healthcarev1beta1.ConsentHeaderHandlingProfileScopeProfileUnspecified,
},
EnforcedAdminConsents: pulumi.StringArray{
pulumi.String("string"),
},
},
FhirStoreId: pulumi.String("string"),
Location: pulumi.String("string"),
ComplexDataTypeReferenceParsing: healthcarev1beta1.FhirStoreComplexDataTypeReferenceParsingComplexDataTypeReferenceParsingUnspecified,
NotificationConfigs: healthcare.FhirNotificationConfigArray{
&healthcare.FhirNotificationConfigArgs{
PubsubTopic: pulumi.String("string"),
SendFullResource: pulumi.Bool(false),
SendPreviousResourceOnDelete: pulumi.Bool(false),
},
},
Project: pulumi.String("string"),
SearchConfig: &healthcare.SearchConfigArgs{
SearchParameters: healthcare.SearchParameterArray{
&healthcare.SearchParameterArgs{
CanonicalUrl: pulumi.String("string"),
Parameter: pulumi.String("string"),
},
},
},
StreamConfigs: healthcare.StreamConfigArray{
&healthcare.StreamConfigArgs{
BigqueryDestination: &healthcare.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationArgs{
DatasetUri: pulumi.String("string"),
Force: pulumi.Bool(false),
SchemaConfig: &healthcare.SchemaConfigArgs{
LastUpdatedPartitionConfig: &healthcare.TimePartitioningArgs{
ExpirationMs: pulumi.String("string"),
Type: healthcarev1beta1.TimePartitioningTypePartitionTypeUnspecified,
},
RecursiveStructureDepth: pulumi.String("string"),
SchemaType: healthcarev1beta1.SchemaConfigSchemaTypeSchemaTypeUnspecified,
},
WriteDisposition: healthcarev1beta1.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDispositionWriteDispositionUnspecified,
},
DeidentifiedStoreDestination: &healthcare.DeidentifiedStoreDestinationArgs{
Config: &healthcare.DeidentifyConfigArgs{
Annotation: &healthcare.AnnotationConfigArgs{
AnnotationStoreName: pulumi.String("string"),
StoreQuote: pulumi.Bool(false),
},
DicomTagConfig: &healthcare.DicomTagConfigArgs{
Actions: healthcare.ActionArray{
&healthcare.ActionArgs{
CleanImageTag: &healthcare.ImageConfigArgs{
AdditionalInfoTypes: pulumi.StringArray{
pulumi.String("string"),
},
ExcludeInfoTypes: pulumi.StringArray{
pulumi.String("string"),
},
TextRedactionMode: healthcarev1beta1.ImageConfigTextRedactionModeTextRedactionModeUnspecified,
},
CleanTextTag: &healthcare.CleanTextTagArgs{},
DeleteTag: &healthcare.DeleteTagArgs{},
KeepTag: &healthcare.KeepTagArgs{},
Queries: pulumi.StringArray{
pulumi.String("string"),
},
RecurseTag: &healthcare.RecurseTagArgs{},
RegenUidTag: &healthcare.RegenUidTagArgs{},
RemoveTag: &healthcare.RemoveTagArgs{},
ResetTag: &healthcare.ResetTagArgs{},
},
},
Options: &healthcare.OptionsArgs{
CleanDescriptors: &healthcare.CleanDescriptorsOptionArgs{},
CleanImage: &healthcare.ImageConfigArgs{
AdditionalInfoTypes: pulumi.StringArray{
pulumi.String("string"),
},
ExcludeInfoTypes: pulumi.StringArray{
pulumi.String("string"),
},
TextRedactionMode: healthcarev1beta1.ImageConfigTextRedactionModeTextRedactionModeUnspecified,
},
PrimaryIds: healthcarev1beta1.OptionsPrimaryIdsPrimaryIdsOptionUnspecified,
},
ProfileType: healthcarev1beta1.DicomTagConfigProfileTypeProfileTypeUnspecified,
},
FhirFieldConfig: &healthcare.FhirFieldConfigArgs{
FieldMetadataList: healthcare.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataArray{
&healthcare.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataArgs{
CharacterMaskField: &healthcare.CharacterMaskFieldArgs{},
CleanTextField: &healthcare.CleanTextFieldArgs{},
CryptoHashField: &healthcare.CryptoHashFieldArgs{},
DateShiftField: &healthcare.DateShiftFieldArgs{},
KeepField: &healthcare.KeepFieldArgs{},
Paths: pulumi.StringArray{
pulumi.String("string"),
},
RemoveField: &healthcare.RemoveFieldArgs{},
},
},
Options: &healthcare.GoogleCloudHealthcareV1beta1DeidentifyOptionsArgs{
CharacterMaskConfig: &healthcare.CharacterMaskConfigArgs{
MaskingCharacter: pulumi.String("string"),
},
ContextualDeid: &healthcare.ContextualDeidConfigArgs{},
CryptoHashConfig: &healthcare.CryptoHashConfigArgs{
CryptoKey: pulumi.String("string"),
KmsWrapped: &healthcare.KmsWrappedCryptoKeyArgs{
CryptoKey: pulumi.String("string"),
WrappedKey: pulumi.String("string"),
},
},
DateShiftConfig: &healthcare.DateShiftConfigArgs{
CryptoKey: pulumi.String("string"),
KmsWrapped: &healthcare.KmsWrappedCryptoKeyArgs{
CryptoKey: pulumi.String("string"),
WrappedKey: pulumi.String("string"),
},
},
KeepExtensions: &healthcare.KeepExtensionsConfigArgs{},
},
ProfileType: healthcarev1beta1.FhirFieldConfigProfileTypeProfileTypeUnspecified,
},
OperationMetadata: &healthcare.DeidentifyOperationMetadataArgs{
FhirOutput: healthcare.FhirOutputArgs{
FhirStore: pulumi.String("string"),
},
},
Text: &healthcare.TextConfigArgs{
AdditionalTransformations: healthcare.InfoTypeTransformationArray{
&healthcare.InfoTypeTransformationArgs{
CharacterMaskConfig: &healthcare.CharacterMaskConfigArgs{
MaskingCharacter: pulumi.String("string"),
},
CryptoHashConfig: &healthcare.CryptoHashConfigArgs{
CryptoKey: pulumi.String("string"),
KmsWrapped: &healthcare.KmsWrappedCryptoKeyArgs{
CryptoKey: pulumi.String("string"),
WrappedKey: pulumi.String("string"),
},
},
DateShiftConfig: &healthcare.DateShiftConfigArgs{
CryptoKey: pulumi.String("string"),
KmsWrapped: &healthcare.KmsWrappedCryptoKeyArgs{
CryptoKey: pulumi.String("string"),
WrappedKey: pulumi.String("string"),
},
},
InfoTypes: pulumi.StringArray{
pulumi.String("string"),
},
RedactConfig: &healthcare.RedactConfigArgs{},
ReplaceWithInfoTypeConfig: &healthcare.ReplaceWithInfoTypeConfigArgs{},
},
},
ExcludeInfoTypes: pulumi.StringArray{
pulumi.String("string"),
},
ProfileType: healthcarev1beta1.TextConfigProfileTypeProfileTypeUnspecified,
},
UseRegionalDataProcessing: pulumi.Bool(false),
},
Store: pulumi.String("string"),
},
ResourceTypes: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ValidationConfig: &healthcare.ValidationConfigArgs{
DisableFhirpathValidation: pulumi.Bool(false),
DisableProfileValidation: pulumi.Bool(false),
DisableReferenceTypeValidation: pulumi.Bool(false),
DisableRequiredFieldValidation: pulumi.Bool(false),
EnabledImplementationGuides: pulumi.StringArray{
pulumi.String("string"),
},
},
Version: healthcarev1beta1.FhirStoreVersionVersionUnspecified,
})
resource "google-native_healthcare_v1beta1_fhir_store" "google-nativeFhirStoreResource" {
lifecycle {
create_before_destroy = true
}
dataset_id = "string"
labels = {
"string" = "string"
}
default_search_handling_strict = false
disable_referential_integrity = false
disable_resource_versioning = false
enable_update_create = false
consent_config = {
version = "CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED"
access_determination_log_config = {
log_level = "LOG_LEVEL_UNSPECIFIED"
}
access_enforced = false
consent_header_handling = {
profile = "SCOPE_PROFILE_UNSPECIFIED"
}
enforced_admin_consents = ["string"]
}
fhir_store_id = "string"
location = "string"
complex_data_type_reference_parsing = "COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED"
notification_configs {
pubsub_topic = "string"
send_full_resource = false
send_previous_resource_on_delete = false
}
project = "string"
search_config = {
search_parameters = [{
canonical_url = "string"
parameter = "string"
}]
}
stream_configs {
bigquery_destination = {
dataset_uri = "string"
force = false
schema_config = {
last_updated_partition_config = {
expiration_ms = "string"
type = "PARTITION_TYPE_UNSPECIFIED"
}
recursive_structure_depth = "string"
schema_type = "SCHEMA_TYPE_UNSPECIFIED"
}
write_disposition = "WRITE_DISPOSITION_UNSPECIFIED"
}
deidentified_store_destination = {
config = {
annotation = {
annotation_store_name = "string"
store_quote = false
}
dicom_tag_config = {
actions = [{
clean_image_tag = {
additional_info_types = ["string"]
exclude_info_types = ["string"]
text_redaction_mode = "TEXT_REDACTION_MODE_UNSPECIFIED"
}
clean_text_tag = {}
delete_tag = {}
keep_tag = {}
queries = ["string"]
recurse_tag = {}
regen_uid_tag = {}
remove_tag = {}
reset_tag = {}
}]
options = {
clean_descriptors = {}
clean_image = {
additional_info_types = ["string"]
exclude_info_types = ["string"]
text_redaction_mode = "TEXT_REDACTION_MODE_UNSPECIFIED"
}
primary_ids = "PRIMARY_IDS_OPTION_UNSPECIFIED"
}
profile_type = "PROFILE_TYPE_UNSPECIFIED"
}
fhir_field_config = {
field_metadata_list = [{
character_mask_field = {}
clean_text_field = {}
crypto_hash_field = {}
date_shift_field = {}
keep_field = {}
paths = ["string"]
remove_field = {}
}]
options = {
character_mask_config = {
masking_character = "string"
}
contextual_deid = {}
crypto_hash_config = {
crypto_key = "string"
kms_wrapped = {
crypto_key = "string"
wrapped_key = "string"
}
}
date_shift_config = {
crypto_key = "string"
kms_wrapped = {
crypto_key = "string"
wrapped_key = "string"
}
}
keep_extensions = {}
}
profile_type = "PROFILE_TYPE_UNSPECIFIED"
}
operation_metadata = {
fhir_output = {
fhir_store = "string"
}
}
text = {
additional_transformations = [{
character_mask_config = {
masking_character = "string"
}
crypto_hash_config = {
crypto_key = "string"
kms_wrapped = {
crypto_key = "string"
wrapped_key = "string"
}
}
date_shift_config = {
crypto_key = "string"
kms_wrapped = {
crypto_key = "string"
wrapped_key = "string"
}
}
info_types = ["string"]
redact_config = {}
replace_with_info_type_config = {}
}]
exclude_info_types = ["string"]
profile_type = "PROFILE_TYPE_UNSPECIFIED"
}
use_regional_data_processing = false
}
store = "string"
}
resource_types = ["string"]
}
validation_config = {
disable_fhirpath_validation = false
disable_profile_validation = false
disable_reference_type_validation = false
disable_required_field_validation = false
enabled_implementation_guides = ["string"]
}
version = "VERSION_UNSPECIFIED"
}
var google_nativeFhirStoreResource = new com.pulumi.googlenative.healthcare_v1beta1.FhirStore("google-nativeFhirStoreResource", com.pulumi.googlenative.healthcare_v1beta1.FhirStoreArgs.builder()
.datasetId("string")
.labels(Map.of("string", "string"))
.defaultSearchHandlingStrict(false)
.disableReferentialIntegrity(false)
.disableResourceVersioning(false)
.enableUpdateCreate(false)
.consentConfig(ConsentConfigArgs.builder()
.version(com.pulumi.googlenative.healthcare_v1beta1.enums.ConsentConfigVersion.ConsentEnforcementVersionUnspecified)
.accessDeterminationLogConfig(AccessDeterminationLogConfigArgs.builder()
.logLevel(com.pulumi.googlenative.healthcare_v1beta1.enums.AccessDeterminationLogConfigLogLevel.LogLevelUnspecified)
.build())
.accessEnforced(false)
.consentHeaderHandling(ConsentHeaderHandlingArgs.builder()
.profile(com.pulumi.googlenative.healthcare_v1beta1.enums.ConsentHeaderHandlingProfile.ScopeProfileUnspecified)
.build())
.enforcedAdminConsents("string")
.build())
.fhirStoreId("string")
.location("string")
.complexDataTypeReferenceParsing(com.pulumi.googlenative.healthcare_v1beta1.enums.FhirStoreComplexDataTypeReferenceParsing.ComplexDataTypeReferenceParsingUnspecified)
.notificationConfigs(com.pulumi.googlenative.healthcare_v1beta1.inputs.FhirNotificationConfigArgs.builder()
.pubsubTopic("string")
.sendFullResource(false)
.sendPreviousResourceOnDelete(false)
.build())
.project("string")
.searchConfig(SearchConfigArgs.builder()
.searchParameters(SearchParameterArgs.builder()
.canonicalUrl("string")
.parameter("string")
.build())
.build())
.streamConfigs(com.pulumi.googlenative.healthcare_v1beta1.inputs.StreamConfigArgs.builder()
.bigqueryDestination(GoogleCloudHealthcareV1beta1FhirBigQueryDestinationArgs.builder()
.datasetUri("string")
.force(false)
.schemaConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.SchemaConfigArgs.builder()
.lastUpdatedPartitionConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.TimePartitioningArgs.builder()
.expirationMs("string")
.type(com.pulumi.googlenative.healthcare_v1beta1.enums.TimePartitioningType.PartitionTypeUnspecified)
.build())
.recursiveStructureDepth("string")
.schemaType(com.pulumi.googlenative.healthcare_v1beta1.enums.SchemaConfigSchemaType.SchemaTypeUnspecified)
.build())
.writeDisposition(com.pulumi.googlenative.healthcare_v1beta1.enums.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition.WriteDispositionUnspecified)
.build())
.deidentifiedStoreDestination(com.pulumi.googlenative.healthcare_v1beta1.inputs.DeidentifiedStoreDestinationArgs.builder()
.config(com.pulumi.googlenative.healthcare_v1beta1.inputs.DeidentifyConfigArgs.builder()
.annotation(AnnotationConfigArgs.builder()
.annotationStoreName("string")
.storeQuote(false)
.build())
.dicomTagConfig(DicomTagConfigArgs.builder()
.actions(ActionArgs.builder()
.cleanImageTag(com.pulumi.googlenative.healthcare_v1beta1.inputs.ImageConfigArgs.builder()
.additionalInfoTypes("string")
.excludeInfoTypes("string")
.textRedactionMode(com.pulumi.googlenative.healthcare_v1beta1.enums.ImageConfigTextRedactionMode.TextRedactionModeUnspecified)
.build())
.cleanTextTag(CleanTextTagArgs.builder()
.build())
.deleteTag(DeleteTagArgs.builder()
.build())
.keepTag(KeepTagArgs.builder()
.build())
.queries("string")
.recurseTag(RecurseTagArgs.builder()
.build())
.regenUidTag(RegenUidTagArgs.builder()
.build())
.removeTag(RemoveTagArgs.builder()
.build())
.resetTag(ResetTagArgs.builder()
.build())
.build())
.options(com.pulumi.googlenative.healthcare_v1beta1.inputs.OptionsArgs.builder()
.cleanDescriptors(CleanDescriptorsOptionArgs.builder()
.build())
.cleanImage(com.pulumi.googlenative.healthcare_v1beta1.inputs.ImageConfigArgs.builder()
.additionalInfoTypes("string")
.excludeInfoTypes("string")
.textRedactionMode(com.pulumi.googlenative.healthcare_v1beta1.enums.ImageConfigTextRedactionMode.TextRedactionModeUnspecified)
.build())
.primaryIds(com.pulumi.googlenative.healthcare_v1beta1.enums.OptionsPrimaryIds.PrimaryIdsOptionUnspecified)
.build())
.profileType(com.pulumi.googlenative.healthcare_v1beta1.enums.DicomTagConfigProfileType.ProfileTypeUnspecified)
.build())
.fhirFieldConfig(FhirFieldConfigArgs.builder()
.fieldMetadataList(GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataArgs.builder()
.characterMaskField(CharacterMaskFieldArgs.builder()
.build())
.cleanTextField(CleanTextFieldArgs.builder()
.build())
.cryptoHashField(CryptoHashFieldArgs.builder()
.build())
.dateShiftField(DateShiftFieldArgs.builder()
.build())
.keepField(KeepFieldArgs.builder()
.build())
.paths("string")
.removeField(RemoveFieldArgs.builder()
.build())
.build())
.options(GoogleCloudHealthcareV1beta1DeidentifyOptionsArgs.builder()
.characterMaskConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.CharacterMaskConfigArgs.builder()
.maskingCharacter("string")
.build())
.contextualDeid(ContextualDeidConfigArgs.builder()
.build())
.cryptoHashConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.CryptoHashConfigArgs.builder()
.cryptoKey("string")
.kmsWrapped(com.pulumi.googlenative.healthcare_v1beta1.inputs.KmsWrappedCryptoKeyArgs.builder()
.cryptoKey("string")
.wrappedKey("string")
.build())
.build())
.dateShiftConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.DateShiftConfigArgs.builder()
.cryptoKey("string")
.kmsWrapped(com.pulumi.googlenative.healthcare_v1beta1.inputs.KmsWrappedCryptoKeyArgs.builder()
.cryptoKey("string")
.wrappedKey("string")
.build())
.build())
.keepExtensions(KeepExtensionsConfigArgs.builder()
.build())
.build())
.profileType(com.pulumi.googlenative.healthcare_v1beta1.enums.FhirFieldConfigProfileType.ProfileTypeUnspecified)
.build())
.operationMetadata(DeidentifyOperationMetadataArgs.builder()
.fhirOutput(FhirOutputArgs.builder()
.fhirStore("string")
.build())
.build())
.text(com.pulumi.googlenative.healthcare_v1beta1.inputs.TextConfigArgs.builder()
.additionalTransformations(com.pulumi.googlenative.healthcare_v1beta1.inputs.InfoTypeTransformationArgs.builder()
.characterMaskConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.CharacterMaskConfigArgs.builder()
.maskingCharacter("string")
.build())
.cryptoHashConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.CryptoHashConfigArgs.builder()
.cryptoKey("string")
.kmsWrapped(com.pulumi.googlenative.healthcare_v1beta1.inputs.KmsWrappedCryptoKeyArgs.builder()
.cryptoKey("string")
.wrappedKey("string")
.build())
.build())
.dateShiftConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.DateShiftConfigArgs.builder()
.cryptoKey("string")
.kmsWrapped(com.pulumi.googlenative.healthcare_v1beta1.inputs.KmsWrappedCryptoKeyArgs.builder()
.cryptoKey("string")
.wrappedKey("string")
.build())
.build())
.infoTypes("string")
.redactConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.RedactConfigArgs.builder()
.build())
.replaceWithInfoTypeConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.ReplaceWithInfoTypeConfigArgs.builder()
.build())
.build())
.excludeInfoTypes("string")
.profileType(com.pulumi.googlenative.healthcare_v1beta1.enums.TextConfigProfileType.ProfileTypeUnspecified)
.build())
.useRegionalDataProcessing(false)
.build())
.store("string")
.build())
.resourceTypes("string")
.build())
.validationConfig(com.pulumi.googlenative.healthcare_v1beta1.inputs.ValidationConfigArgs.builder()
.disableFhirpathValidation(false)
.disableProfileValidation(false)
.disableReferenceTypeValidation(false)
.disableRequiredFieldValidation(false)
.enabledImplementationGuides("string")
.build())
.version(com.pulumi.googlenative.healthcare_v1beta1.enums.FhirStoreVersion.VersionUnspecified)
.build());
google_native_fhir_store_resource = google_native.healthcare.v1beta1.FhirStore("google-nativeFhirStoreResource",
dataset_id="string",
labels={
"string": "string",
},
default_search_handling_strict=False,
disable_referential_integrity=False,
disable_resource_versioning=False,
enable_update_create=False,
consent_config={
"version": google_native.healthcare.v1beta1.ConsentConfigVersion.CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED,
"access_determination_log_config": {
"log_level": google_native.healthcare.v1beta1.AccessDeterminationLogConfigLogLevel.LOG_LEVEL_UNSPECIFIED,
},
"access_enforced": False,
"consent_header_handling": {
"profile": google_native.healthcare.v1beta1.ConsentHeaderHandlingProfile.SCOPE_PROFILE_UNSPECIFIED,
},
"enforced_admin_consents": ["string"],
},
fhir_store_id="string",
location="string",
complex_data_type_reference_parsing=google_native.healthcare.v1beta1.FhirStoreComplexDataTypeReferenceParsing.COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED,
notification_configs=[{
"pubsub_topic": "string",
"send_full_resource": False,
"send_previous_resource_on_delete": False,
}],
project="string",
search_config={
"search_parameters": [{
"canonical_url": "string",
"parameter": "string",
}],
},
stream_configs=[{
"bigquery_destination": {
"dataset_uri": "string",
"force": False,
"schema_config": {
"last_updated_partition_config": {
"expiration_ms": "string",
"type": google_native.healthcare.v1beta1.TimePartitioningType.PARTITION_TYPE_UNSPECIFIED,
},
"recursive_structure_depth": "string",
"schema_type": google_native.healthcare.v1beta1.SchemaConfigSchemaType.SCHEMA_TYPE_UNSPECIFIED,
},
"write_disposition": google_native.healthcare.v1beta1.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition.WRITE_DISPOSITION_UNSPECIFIED,
},
"deidentified_store_destination": {
"config": {
"annotation": {
"annotation_store_name": "string",
"store_quote": False,
},
"dicom_tag_config": {
"actions": [{
"clean_image_tag": {
"additional_info_types": ["string"],
"exclude_info_types": ["string"],
"text_redaction_mode": google_native.healthcare.v1beta1.ImageConfigTextRedactionMode.TEXT_REDACTION_MODE_UNSPECIFIED,
},
"clean_text_tag": {},
"delete_tag": {},
"keep_tag": {},
"queries": ["string"],
"recurse_tag": {},
"regen_uid_tag": {},
"remove_tag": {},
"reset_tag": {},
}],
"options": {
"clean_descriptors": {},
"clean_image": {
"additional_info_types": ["string"],
"exclude_info_types": ["string"],
"text_redaction_mode": google_native.healthcare.v1beta1.ImageConfigTextRedactionMode.TEXT_REDACTION_MODE_UNSPECIFIED,
},
"primary_ids": google_native.healthcare.v1beta1.OptionsPrimaryIds.PRIMARY_IDS_OPTION_UNSPECIFIED,
},
"profile_type": google_native.healthcare.v1beta1.DicomTagConfigProfileType.PROFILE_TYPE_UNSPECIFIED,
},
"fhir_field_config": {
"field_metadata_list": [{
"character_mask_field": {},
"clean_text_field": {},
"crypto_hash_field": {},
"date_shift_field": {},
"keep_field": {},
"paths": ["string"],
"remove_field": {},
}],
"options": {
"character_mask_config": {
"masking_character": "string",
},
"contextual_deid": {},
"crypto_hash_config": {
"crypto_key": "string",
"kms_wrapped": {
"crypto_key": "string",
"wrapped_key": "string",
},
},
"date_shift_config": {
"crypto_key": "string",
"kms_wrapped": {
"crypto_key": "string",
"wrapped_key": "string",
},
},
"keep_extensions": {},
},
"profile_type": google_native.healthcare.v1beta1.FhirFieldConfigProfileType.PROFILE_TYPE_UNSPECIFIED,
},
"operation_metadata": {
"fhir_output": {
"fhir_store": "string",
},
},
"text": {
"additional_transformations": [{
"character_mask_config": {
"masking_character": "string",
},
"crypto_hash_config": {
"crypto_key": "string",
"kms_wrapped": {
"crypto_key": "string",
"wrapped_key": "string",
},
},
"date_shift_config": {
"crypto_key": "string",
"kms_wrapped": {
"crypto_key": "string",
"wrapped_key": "string",
},
},
"info_types": ["string"],
"redact_config": {},
"replace_with_info_type_config": {},
}],
"exclude_info_types": ["string"],
"profile_type": google_native.healthcare.v1beta1.TextConfigProfileType.PROFILE_TYPE_UNSPECIFIED,
},
"use_regional_data_processing": False,
},
"store": "string",
},
"resource_types": ["string"],
}],
validation_config={
"disable_fhirpath_validation": False,
"disable_profile_validation": False,
"disable_reference_type_validation": False,
"disable_required_field_validation": False,
"enabled_implementation_guides": ["string"],
},
version=google_native.healthcare.v1beta1.FhirStoreVersion.VERSION_UNSPECIFIED)
const google_nativeFhirStoreResource = new google_native.healthcare.v1beta1.FhirStore("google-nativeFhirStoreResource", {
datasetId: "string",
labels: {
string: "string",
},
defaultSearchHandlingStrict: false,
disableReferentialIntegrity: false,
disableResourceVersioning: false,
enableUpdateCreate: false,
consentConfig: {
version: google_native.healthcare.v1beta1.ConsentConfigVersion.ConsentEnforcementVersionUnspecified,
accessDeterminationLogConfig: {
logLevel: google_native.healthcare.v1beta1.AccessDeterminationLogConfigLogLevel.LogLevelUnspecified,
},
accessEnforced: false,
consentHeaderHandling: {
profile: google_native.healthcare.v1beta1.ConsentHeaderHandlingProfile.ScopeProfileUnspecified,
},
enforcedAdminConsents: ["string"],
},
fhirStoreId: "string",
location: "string",
complexDataTypeReferenceParsing: google_native.healthcare.v1beta1.FhirStoreComplexDataTypeReferenceParsing.ComplexDataTypeReferenceParsingUnspecified,
notificationConfigs: [{
pubsubTopic: "string",
sendFullResource: false,
sendPreviousResourceOnDelete: false,
}],
project: "string",
searchConfig: {
searchParameters: [{
canonicalUrl: "string",
parameter: "string",
}],
},
streamConfigs: [{
bigqueryDestination: {
datasetUri: "string",
force: false,
schemaConfig: {
lastUpdatedPartitionConfig: {
expirationMs: "string",
type: google_native.healthcare.v1beta1.TimePartitioningType.PartitionTypeUnspecified,
},
recursiveStructureDepth: "string",
schemaType: google_native.healthcare.v1beta1.SchemaConfigSchemaType.SchemaTypeUnspecified,
},
writeDisposition: google_native.healthcare.v1beta1.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition.WriteDispositionUnspecified,
},
deidentifiedStoreDestination: {
config: {
annotation: {
annotationStoreName: "string",
storeQuote: false,
},
dicomTagConfig: {
actions: [{
cleanImageTag: {
additionalInfoTypes: ["string"],
excludeInfoTypes: ["string"],
textRedactionMode: google_native.healthcare.v1beta1.ImageConfigTextRedactionMode.TextRedactionModeUnspecified,
},
cleanTextTag: {},
deleteTag: {},
keepTag: {},
queries: ["string"],
recurseTag: {},
regenUidTag: {},
removeTag: {},
resetTag: {},
}],
options: {
cleanDescriptors: {},
cleanImage: {
additionalInfoTypes: ["string"],
excludeInfoTypes: ["string"],
textRedactionMode: google_native.healthcare.v1beta1.ImageConfigTextRedactionMode.TextRedactionModeUnspecified,
},
primaryIds: google_native.healthcare.v1beta1.OptionsPrimaryIds.PrimaryIdsOptionUnspecified,
},
profileType: google_native.healthcare.v1beta1.DicomTagConfigProfileType.ProfileTypeUnspecified,
},
fhirFieldConfig: {
fieldMetadataList: [{
characterMaskField: {},
cleanTextField: {},
cryptoHashField: {},
dateShiftField: {},
keepField: {},
paths: ["string"],
removeField: {},
}],
options: {
characterMaskConfig: {
maskingCharacter: "string",
},
contextualDeid: {},
cryptoHashConfig: {
cryptoKey: "string",
kmsWrapped: {
cryptoKey: "string",
wrappedKey: "string",
},
},
dateShiftConfig: {
cryptoKey: "string",
kmsWrapped: {
cryptoKey: "string",
wrappedKey: "string",
},
},
keepExtensions: {},
},
profileType: google_native.healthcare.v1beta1.FhirFieldConfigProfileType.ProfileTypeUnspecified,
},
operationMetadata: {
fhirOutput: {
fhirStore: "string",
},
},
text: {
additionalTransformations: [{
characterMaskConfig: {
maskingCharacter: "string",
},
cryptoHashConfig: {
cryptoKey: "string",
kmsWrapped: {
cryptoKey: "string",
wrappedKey: "string",
},
},
dateShiftConfig: {
cryptoKey: "string",
kmsWrapped: {
cryptoKey: "string",
wrappedKey: "string",
},
},
infoTypes: ["string"],
redactConfig: {},
replaceWithInfoTypeConfig: {},
}],
excludeInfoTypes: ["string"],
profileType: google_native.healthcare.v1beta1.TextConfigProfileType.ProfileTypeUnspecified,
},
useRegionalDataProcessing: false,
},
store: "string",
},
resourceTypes: ["string"],
}],
validationConfig: {
disableFhirpathValidation: false,
disableProfileValidation: false,
disableReferenceTypeValidation: false,
disableRequiredFieldValidation: false,
enabledImplementationGuides: ["string"],
},
version: google_native.healthcare.v1beta1.FhirStoreVersion.VersionUnspecified,
});
type: google-native:healthcare/v1beta1:FhirStore
properties:
complexDataTypeReferenceParsing: COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED
consentConfig:
accessDeterminationLogConfig:
logLevel: LOG_LEVEL_UNSPECIFIED
accessEnforced: false
consentHeaderHandling:
profile: SCOPE_PROFILE_UNSPECIFIED
enforcedAdminConsents:
- string
version: CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED
datasetId: string
defaultSearchHandlingStrict: false
disableReferentialIntegrity: false
disableResourceVersioning: false
enableUpdateCreate: false
fhirStoreId: string
labels:
string: string
location: string
notificationConfigs:
- pubsubTopic: string
sendFullResource: false
sendPreviousResourceOnDelete: false
project: string
searchConfig:
searchParameters:
- canonicalUrl: string
parameter: string
streamConfigs:
- bigqueryDestination:
datasetUri: string
force: false
schemaConfig:
lastUpdatedPartitionConfig:
expirationMs: string
type: PARTITION_TYPE_UNSPECIFIED
recursiveStructureDepth: string
schemaType: SCHEMA_TYPE_UNSPECIFIED
writeDisposition: WRITE_DISPOSITION_UNSPECIFIED
deidentifiedStoreDestination:
config:
annotation:
annotationStoreName: string
storeQuote: false
dicomTagConfig:
actions:
- cleanImageTag:
additionalInfoTypes:
- string
excludeInfoTypes:
- string
textRedactionMode: TEXT_REDACTION_MODE_UNSPECIFIED
cleanTextTag: {}
deleteTag: {}
keepTag: {}
queries:
- string
recurseTag: {}
regenUidTag: {}
removeTag: {}
resetTag: {}
options:
cleanDescriptors: {}
cleanImage:
additionalInfoTypes:
- string
excludeInfoTypes:
- string
textRedactionMode: TEXT_REDACTION_MODE_UNSPECIFIED
primaryIds: PRIMARY_IDS_OPTION_UNSPECIFIED
profileType: PROFILE_TYPE_UNSPECIFIED
fhirFieldConfig:
fieldMetadataList:
- characterMaskField: {}
cleanTextField: {}
cryptoHashField: {}
dateShiftField: {}
keepField: {}
paths:
- string
removeField: {}
options:
characterMaskConfig:
maskingCharacter: string
contextualDeid: {}
cryptoHashConfig:
cryptoKey: string
kmsWrapped:
cryptoKey: string
wrappedKey: string
dateShiftConfig:
cryptoKey: string
kmsWrapped:
cryptoKey: string
wrappedKey: string
keepExtensions: {}
profileType: PROFILE_TYPE_UNSPECIFIED
operationMetadata:
fhirOutput:
fhirStore: string
text:
additionalTransformations:
- characterMaskConfig:
maskingCharacter: string
cryptoHashConfig:
cryptoKey: string
kmsWrapped:
cryptoKey: string
wrappedKey: string
dateShiftConfig:
cryptoKey: string
kmsWrapped:
cryptoKey: string
wrappedKey: string
infoTypes:
- string
redactConfig: {}
replaceWithInfoTypeConfig: {}
excludeInfoTypes:
- string
profileType: PROFILE_TYPE_UNSPECIFIED
useRegionalDataProcessing: false
store: string
resourceTypes:
- string
validationConfig:
disableFhirpathValidation: false
disableProfileValidation: false
disableReferenceTypeValidation: false
disableRequiredFieldValidation: false
enabledImplementationGuides:
- string
version: VERSION_UNSPECIFIED
FhirStore Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FhirStore resource accepts the following input properties:
- DatasetId
string
- ComplexDataTypeReferenceParsing
Pulumi.GoogleNative.Healthcare.V1Beta1.FhirStoreComplexDataTypeReferenceParsing
- 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.
- ConsentConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ConsentConfig
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- DefaultSearchHandlingStrict
bool
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - DisableReferentialIntegrity
bool
- 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.
- DisableResourceVersioning
bool
- 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.
- EnableUpdateCreate
bool
- 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.
- FhirStoreId
string
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- Location
string
- NotificationConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.NotificationConfig
- Deprecated. Use
notification_configs instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".Deprecated: 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".
- NotificationConfigs
List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.FhirNotificationConfig>
- Specifies where and whether to send notifications upon changes to a Fhir store.
- Project
string
- SearchConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.SearchConfig
- Configuration for how FHIR resources can be searched.
- StreamConfigs
List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.StreamConfig>
- 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. - ValidationConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ValidationConfig
- Configuration for how to validate incoming FHIR resources against configured profiles.
- Version
Pulumi.GoogleNative.Healthcare.V1Beta1.FhirStoreVersion
- 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.
- DatasetId
string
- ComplexDataTypeReferenceParsing
FhirStoreComplexDataTypeReferenceParsing
- 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.
- ConsentConfig
ConsentConfigArgs
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- DefaultSearchHandlingStrict
bool
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - DisableReferentialIntegrity
bool
- 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.
- DisableResourceVersioning
bool
- 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.
- EnableUpdateCreate
bool
- 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.
- FhirStoreId
string
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- Location
string
- NotificationConfig
NotificationConfigArgs
- 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".Deprecated: 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".
- NotificationConfigs
[]FhirNotificationConfigArgs
- Specifies where and whether to send notifications upon changes to a Fhir store.
- Project
string
- SearchConfig
SearchConfigArgs
- Configuration for how FHIR resources can be searched.
- StreamConfigs
[]StreamConfigArgs
- 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. - ValidationConfig
ValidationConfigArgs
- Configuration for how to validate incoming FHIR resources against configured profiles.
- Version
FhirStoreVersion
- 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.
- dataset_id
string
- complex_data_type_reference_parsing
"COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED" | "DISABLED" | "ENABLED"
- 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
object
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- default_search_handling_strict
bool
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - disable_referential_integrity
bool
- 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_versioning
bool
- 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_create
bool
- 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.
- fhir_store_id
string
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- location
string
- notification_config
object
- 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".Deprecated: 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(object)
- Specifies where and whether to send notifications upon changes to a Fhir store.
- project
string
- search_config
object
- Configuration for how FHIR resources can be searched.
- stream_configs
list(object)
- 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
object
- Configuration for how to validate incoming FHIR resources against configured profiles.
- version
"VERSION_UNSPECIFIED" | "DSTU2" | "STU3" | "R4"
- 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.
- datasetId
String
- complexDataTypeReferenceParsing
FhirStoreComplexDataTypeReferenceParsing
- 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.
- consentConfig
ConsentConfig
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- defaultSearchHandlingStrict
Boolean
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - disableReferentialIntegrity
Boolean
- 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.
- disableResourceVersioning
Boolean
- 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.
- enableUpdateCreate
Boolean
- 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.
- fhirStoreId
String
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- location
String
- notificationConfig
NotificationConfig
- Deprecated. Use
notification_configs instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".Deprecated: 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".
- notificationConfigs
List<FhirNotificationConfig>
- Specifies where and whether to send notifications upon changes to a Fhir store.
- project
String
- searchConfig
SearchConfig
- Configuration for how FHIR resources can be searched.
- streamConfigs
List<StreamConfig>
- 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. - validationConfig
ValidationConfig
- Configuration for how to validate incoming FHIR resources against configured profiles.
- version
FhirStoreVersion
- 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.
- datasetId
string
- complexDataTypeReferenceParsing
FhirStoreComplexDataTypeReferenceParsing
- 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.
- consentConfig
ConsentConfig
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- defaultSearchHandlingStrict
boolean
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - disableReferentialIntegrity
boolean
- 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.
- disableResourceVersioning
boolean
- 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.
- enableUpdateCreate
boolean
- 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.
- fhirStoreId
string
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- location
string
- notificationConfig
NotificationConfig
- Deprecated. Use
notification_configs instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, "action":"CreateResource".Deprecated: 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".
- notificationConfigs
FhirNotificationConfig[]
- Specifies where and whether to send notifications upon changes to a Fhir store.
- project
string
- searchConfig
SearchConfig
- Configuration for how FHIR resources can be searched.
- streamConfigs
StreamConfig[]
- 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. - validationConfig
ValidationConfig
- Configuration for how to validate incoming FHIR resources against configured profiles.
- version
FhirStoreVersion
- 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.
- dataset_id
str
- complex_data_type_reference_parsing
FhirStoreComplexDataTypeReferenceParsing
- 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
ConsentConfigArgs
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- default_search_handling_strict
bool
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - disable_referential_integrity
bool
- 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_versioning
bool
- 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_create
bool
- 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.
- fhir_store_id
str
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- location
str
- notification_config
NotificationConfigArgs
- 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".Deprecated: 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[FhirNotificationConfigArgs]
- Specifies where and whether to send notifications upon changes to a Fhir store.
- project
str
- search_config
SearchConfigArgs
- Configuration for how FHIR resources can be searched.
- stream_configs
Sequence[StreamConfigArgs]
- 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
ValidationConfigArgs
- Configuration for how to validate incoming FHIR resources against configured profiles.
- version
FhirStoreVersion
- 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.
- datasetId
String
- complexDataTypeReferenceParsing
"COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED" | "DISABLED" | "ENABLED"
- 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.
- consentConfig
Property Map
- Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources.
- defaultSearchHandlingStrict
Boolean
- If true, overrides the default search behavior for this FHIR store to
handling=strict which returns an error for unrecognized search parameters. If false, uses the FHIR specification default handling=lenient which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header Prefer: handling=strict or Prefer: handling=lenient. - disableReferentialIntegrity
Boolean
- 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.
- disableResourceVersioning
Boolean
- 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.
- enableUpdateCreate
Boolean
- 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.
- fhirStoreId
String
- The ID of the FHIR store that is being created. The string must match the following regex:
[\p{L}\p{N}_\-\.]{1,256}. - 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.
- location
String
- notificationConfig
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".Deprecated: 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".
- notificationConfigs
List<Property Map>
- Specifies where and whether to send notifications upon changes to a Fhir store.
- project
String
- searchConfig
Property Map
- Configuration for how FHIR resources can be searched.
- streamConfigs
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. - validationConfig
Property Map
- Configuration for how to validate incoming FHIR resources against configured profiles.
- version
"VERSION_UNSPECIFIED" | "DSTU2" | "STU3" | "R4"
- 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the FhirStore resource produces the following output properties:
- Id
string
- The provider-assigned unique ID for this managed resource.
- Name
string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
- Id
string
- The provider-assigned unique ID for this managed resource.
- Name
string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
- id
string
- The provider-assigned unique ID for this managed resource.
- name
string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
- id
String
- The provider-assigned unique ID for this managed resource.
- name
String
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
- id
string
- The provider-assigned unique ID for this managed resource.
- name
string
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
- id
str
- The provider-assigned unique ID for this managed resource.
- name
str
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
- id
String
- The provider-assigned unique ID for this managed resource.
- name
String
- Resource name of the FHIR store, of the form
projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}.
Look up Existing FhirStore Resource
Get an existing FhirStore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static FhirStore get(String name, Output<String> id, CustomResourceOptions options)
resources: existingFhirStore: type: google-native:healthcare/v1beta1:FhirStore get: id: ${id}
import {
to = google-native_healthcare_v1beta1_fhir_store.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
FhirStoreState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
AccessDeterminationLogConfig, AccessDeterminationLogConfigArgs
Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be enabled. The consent-related logs are included as part of protoPayload.metadata.
AccessDeterminationLogConfigLogLevel
Optional. Controls the amount of detail to include as part of the audit logs.
| Name | Value | Description |
|---|
| LogLevelUnspecified | LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
| Disabled | DISABLED | No additional consent-related logging is added to audit logs. |
| Minimum | MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
| Verbose | VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
| Name | Value | Description |
|---|
| AccessDeterminationLogConfigLogLevelLogLevelUnspecified | LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
| AccessDeterminationLogConfigLogLevelDisabled | DISABLED | No additional consent-related logging is added to audit logs. |
| AccessDeterminationLogConfigLogLevelMinimum | MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
| AccessDeterminationLogConfigLogLevelVerbose | VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
| Value | Description |
|---|
LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
DISABLED | No additional consent-related logging is added to audit logs. |
MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
| Name | Value | Description |
|---|
| LogLevelUnspecified | LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
| Disabled | DISABLED | No additional consent-related logging is added to audit logs. |
| Minimum | MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
| Verbose | VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
| Name | Value | Description |
|---|
| LogLevelUnspecified | LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
| Disabled | DISABLED | No additional consent-related logging is added to audit logs. |
| Minimum | MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
| Verbose | VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
| Name | Value | Description |
|---|
| LOG_LEVEL_UNSPECIFIED | LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
| DISABLED | DISABLED | No additional consent-related logging is added to audit logs. |
| MINIMUM | MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
| VERBOSE | VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
| Value | Description |
|---|
LOG_LEVEL_UNSPECIFIED | No log level specified. This value is unused. |
DISABLED | No additional consent-related logging is added to audit logs. |
MINIMUM | The following information is included: - One of the following consentMode fields: (off|emptyScope|enforced|btg|bypass). - The accessor's request headers - The log_level of the AccessDeterminationLogConfig - The final consent evaluation (PERMIT, DENY, or NO_CONSENT) - A human-readable summary of the evaluation |
VERBOSE | Includes MINIMUM and, for each resource owner, returns: - The resource owner's name - Most specific part of the X-Consent-Scope resulting in consensual determination - Timestamp of the applied enforcement leading to the decision - Enforcement version at the time the applicable consents were applied - The Consent resource name - The timestamp of the Consent resource used for enforcement - Policy type (PATIENT or ADMIN) Note that this mode adds some overhead to CRUD operations. |
AccessDeterminationLogConfigResponse
Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be enabled. The consent-related logs are included as part of protoPayload.metadata.
- LogLevel
string
- Optional. Controls the amount of detail to include as part of the audit logs.
- LogLevel
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.
- logLevel
String
- Optional. Controls the amount of detail to include as part of the audit logs.
- logLevel
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.
- logLevel
String
- Optional. Controls the amount of detail to include as part of the audit logs.
Action, ActionArgs
Specifies a selection of tags and an Action to apply to each one.
- CleanImageTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ImageConfig
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - CleanTextTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CleanTextTag
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- DeleteTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.DeleteTag
- Delete tag.
- KeepTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.KeepTag
- 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"
- RecurseTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RecurseTag
- 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
- RegenUidTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RegenUidTag
- 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
- RemoveTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RemoveTag
- Replace with empty tag.
- ResetTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ResetTag
- Reset tag to a placeholder value.
- CleanImageTag
ImageConfig
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - CleanTextTag
CleanTextTag
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- DeleteTag
DeleteTag
- Delete tag.
- KeepTag
KeepTag
- 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"
- RecurseTag
RecurseTag
- 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
- RegenUidTag
RegenUidTag
- 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
- RemoveTag
RemoveTag
- Replace with empty tag.
- ResetTag
ResetTag
- Reset tag to a placeholder value.
- clean_image_tag
object
- 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_tag
object
- 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
object
- Delete tag.
- keep_tag
object
- 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
object
- 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_tag
object
- 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
object
- Replace with empty tag.
- reset_tag
object
- Reset tag to a placeholder value.
- cleanImageTag
ImageConfig
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - cleanTextTag
CleanTextTag
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- deleteTag
DeleteTag
- Delete tag.
- keepTag
KeepTag
- 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"
- recurseTag
RecurseTag
- 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
- regenUidTag
RegenUidTag
- 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
- removeTag
RemoveTag
- Replace with empty tag.
- resetTag
ResetTag
- Reset tag to a placeholder value.
- cleanImageTag
ImageConfig
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - cleanTextTag
CleanTextTag
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- deleteTag
DeleteTag
- Delete tag.
- keepTag
KeepTag
- 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"
- recurseTag
RecurseTag
- 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
- regenUidTag
RegenUidTag
- 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
- removeTag
RemoveTag
- Replace with empty tag.
- resetTag
ResetTag
- Reset tag to a placeholder value.
- clean_image_tag
ImageConfig
- 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_tag
CleanTextTag
- 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
- Delete tag.
- keep_tag
KeepTag
- 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
- 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_tag
RegenUidTag
- 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
- Replace with empty tag.
- reset_tag
ResetTag
- Reset tag to a placeholder value.
- cleanImageTag
Property Map
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - cleanTextTag
Property Map
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- deleteTag
Property Map
- Delete tag.
- keepTag
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"
- recurseTag
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
- regenUidTag
Property Map
- 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
- removeTag
Property Map
- Replace with empty tag.
- resetTag
Property Map
- Reset tag to a placeholder value.
ActionResponse
Specifies a selection of tags and an Action to apply to each one.
- CleanImageTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ImageConfigResponse
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - CleanTextTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CleanTextTagResponse
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- DeleteTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.DeleteTagResponse
- Delete tag.
- KeepTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.KeepTagResponse
- 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"
- RecurseTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RecurseTagResponse
- 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
- RegenUidTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RegenUidTagResponse
- 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
- RemoveTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RemoveTagResponse
- Replace with empty tag.
- ResetTag
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ResetTagResponse
- Reset tag to a placeholder value.
- CleanImageTag
ImageConfigResponse
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - CleanTextTag
CleanTextTagResponse
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- DeleteTag
DeleteTagResponse
- Delete tag.
- KeepTag
KeepTagResponse
- 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"
- RecurseTag
RecurseTagResponse
- 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
- RegenUidTag
RegenUidTagResponse
- 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
- RemoveTag
RemoveTagResponse
- Replace with empty tag.
- ResetTag
ResetTagResponse
- Reset tag to a placeholder value.
- clean_image_tag
object
- 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_tag
object
- 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
object
- Delete tag.
- keep_tag
object
- 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
object
- 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_tag
object
- 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
object
- Replace with empty tag.
- reset_tag
object
- Reset tag to a placeholder value.
- cleanImageTag
ImageConfigResponse
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - cleanTextTag
CleanTextTagResponse
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- deleteTag
DeleteTagResponse
- Delete tag.
- keepTag
KeepTagResponse
- 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"
- recurseTag
RecurseTagResponse
- 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
- regenUidTag
RegenUidTagResponse
- 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
- removeTag
RemoveTagResponse
- Replace with empty tag.
- resetTag
ResetTagResponse
- Reset tag to a placeholder value.
- cleanImageTag
ImageConfigResponse
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - cleanTextTag
CleanTextTagResponse
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- deleteTag
DeleteTagResponse
- Delete tag.
- keepTag
KeepTagResponse
- 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"
- recurseTag
RecurseTagResponse
- 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
- regenUidTag
RegenUidTagResponse
- 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
- removeTag
RemoveTagResponse
- Replace with empty tag.
- resetTag
ResetTagResponse
- Reset tag to a placeholder value.
- clean_image_tag
ImageConfigResponse
- 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_tag
CleanTextTagResponse
- 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
DeleteTagResponse
- Delete tag.
- keep_tag
KeepTagResponse
- 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
RecurseTagResponse
- 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_tag
RegenUidTagResponse
- 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
RemoveTagResponse
- Replace with empty tag.
- reset_tag
ResetTagResponse
- Reset tag to a placeholder value.
- cleanImageTag
Property Map
- Inspect image and transform sensitive burnt-in text. Doesn't apply to elements nested in a sequence, which revert to
Keep. Supported tags: PixelData - cleanTextTag
Property Map
- Inspect text and transform sensitive text. Configurable via TextConfig. Supported Value Representations: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
- deleteTag
Property Map
- Delete tag.
- keepTag
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"
- recurseTag
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
- regenUidTag
Property Map
- 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
- removeTag
Property Map
- Replace with empty tag.
- resetTag
Property Map
- Reset tag to a placeholder value.
AnnotationConfig, AnnotationConfigArgs
Specifies how to store annotations during de-identification operation.
- AnnotationStoreName
string
- 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. - StoreQuote
bool
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- AnnotationStoreName
string
- 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. - StoreQuote
bool
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation_store_name
string
- 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.
- annotationStoreName
String
- 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. - storeQuote
Boolean
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotationStoreName
string
- 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. - storeQuote
boolean
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation_store_name
str
- 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.
- annotationStoreName
String
- 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. - storeQuote
Boolean
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
AnnotationConfigResponse
Specifies how to store annotations during de-identification operation.
- AnnotationStoreName
string
- 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. - StoreQuote
bool
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- AnnotationStoreName
string
- 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. - StoreQuote
bool
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation_store_name
string
- 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.
- annotationStoreName
String
- 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. - storeQuote
Boolean
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotationStoreName
string
- 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. - storeQuote
boolean
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
- annotation_store_name
str
- 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.
- annotationStoreName
String
- 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. - storeQuote
Boolean
- If set to true, the sensitive texts are included in SensitiveTextAnnotation of Annotation.
CharacterMaskConfig, CharacterMaskConfigArgs
Mask a string by replacing its characters with a fixed character.
- MaskingCharacter
string
- Character to mask the sensitive values. If not supplied, defaults to "*".
- MaskingCharacter
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 "*".
- maskingCharacter
String
- Character to mask the sensitive values. If not supplied, defaults to "*".
- maskingCharacter
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 "*".
- maskingCharacter
String
- Character to mask the sensitive values. If not supplied, defaults to "*".
CharacterMaskConfigResponse
Mask a string by replacing its characters with a fixed character.
- MaskingCharacter
string
- Character to mask the sensitive values. If not supplied, defaults to "*".
- MaskingCharacter
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 "*".
- maskingCharacter
String
- Character to mask the sensitive values. If not supplied, defaults to "*".
- maskingCharacter
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 "*".
- maskingCharacter
String
- Character to mask the sensitive values. If not supplied, defaults to "*".
ConsentConfig, ConsentConfigArgs
Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.
- Version
ConsentConfigVersion
- 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.
- AccessDeterminationLogConfig
AccessDeterminationLogConfig
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - AccessEnforced
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.
- ConsentHeaderHandling
ConsentHeaderHandling
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - EnforcedAdminConsents
[]string
- 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 with disable_resource_versioning=true, the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}. This field can only be updated using ApplyAdminConsents.
- version
"CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED" | "V1"
- 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_log_config
object
- 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_handling
object
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforced_admin_consents
list(string)
- 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 with disable_resource_versioning=true, the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}. This field can only be updated using ApplyAdminConsents.
- version
ConsentConfigVersion
- 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.
- accessDeterminationLogConfig
AccessDeterminationLogConfig
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - accessEnforced
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.
- consentHeaderHandling
ConsentHeaderHandling
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforcedAdminConsents
List<String>
- 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 with disable_resource_versioning=true, the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}. This field can only be updated using ApplyAdminConsents.
- version
ConsentConfigVersion
- 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.
- accessDeterminationLogConfig
AccessDeterminationLogConfig
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - accessEnforced
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.
- consentHeaderHandling
ConsentHeaderHandling
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforcedAdminConsents
string[]
- 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 with disable_resource_versioning=true, the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}. This field can only be updated using ApplyAdminConsents.
- version
ConsentConfigVersion
- 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_log_config
AccessDeterminationLogConfig
- 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_handling
ConsentHeaderHandling
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforced_admin_consents
Sequence[str]
- 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 with disable_resource_versioning=true, the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}. This field can only be updated using ApplyAdminConsents.
- version
"CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED" | "V1"
- 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.
- accessDeterminationLogConfig
Property Map
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - accessEnforced
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.
- consentHeaderHandling
Property Map
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforcedAdminConsents
List<String>
- 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 with disable_resource_versioning=true, the format is projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}. This field can only be updated using ApplyAdminConsents.
ConsentConfigResponse
Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.
- AccessDeterminationLogConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.AccessDeterminationLogConfigResponse
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - AccessEnforced
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.
- ConsentHeaderHandling
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.ConsentHeaderHandlingResponse
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - EnforcedAdminConsents
List<string>
- 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 with disable_resource_versioning=true, the format is projects/{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.
- AccessDeterminationLogConfig
AccessDeterminationLogConfigResponse
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - AccessEnforced
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.
- ConsentHeaderHandling
ConsentHeaderHandlingResponse
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - EnforcedAdminConsents
[]string
- 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 with disable_resource_versioning=true, the format is projects/{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_log_config
object
- 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_handling
object
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforced_admin_consents
list(string)
- 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 with disable_resource_versioning=true, the format is projects/{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.
- accessDeterminationLogConfig
AccessDeterminationLogConfigResponse
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - accessEnforced
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.
- consentHeaderHandling
ConsentHeaderHandlingResponse
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforcedAdminConsents
List<String>
- 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 with disable_resource_versioning=true, the format is projects/{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.
- accessDeterminationLogConfig
AccessDeterminationLogConfigResponse
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - accessEnforced
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.
- consentHeaderHandling
ConsentHeaderHandlingResponse
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforcedAdminConsents
string[]
- 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 with disable_resource_versioning=true, the format is projects/{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_log_config
AccessDeterminationLogConfigResponse
- 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_handling
ConsentHeaderHandlingResponse
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforced_admin_consents
Sequence[str]
- 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 with disable_resource_versioning=true, the format is projects/{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.
- accessDeterminationLogConfig
Property Map
- Optional. Specifies how the server logs the consent-aware requests. If not specified, the
AccessDeterminationLogConfig.LogLevel.MINIMUM option is used. - accessEnforced
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.
- consentHeaderHandling
Property Map
- Optional. Different options to configure the behaviour of the server when handling the
X-Consent-Scope header. - enforcedAdminConsents
List<String>
- 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 with disable_resource_versioning=true, the format is projects/{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.
ConsentConfigVersion
Required. 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.
| Name | Value | Description |
|---|
| ConsentEnforcementVersionUnspecified | CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED | Users must specify an enforcement version or an error is returned. |
| V1 | V1 | Enforcement version 1. See the FHIR Consent resources in the Cloud Healthcare API guide for more details. |
| Name | Value | Description |
|---|
| ConsentConfigVersionConsentEnforcementVersionUnspecified | CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED | Users must specify an enforcement version or an error is returned. |
| ConsentConfigVersionV1 | V1 | Enforcement version 1. See the FHIR Consent resources in the Cloud Healthcare API guide for more details. |
| Name | Value | Description |
|---|
| ConsentEnforcementVersionUnspecified | CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED | Users must specify an enforcement version or an error is returned. |
| V1 | V1 | Enforcement version 1. See the FHIR Consent resources in the Cloud Healthcare API guide for more details. |
| Name | Value | Description |
|---|
| ConsentEnforcementVersionUnspecified | CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED | Users must specify an enforcement version or an error is returned. |
| V1 | V1 | Enforcement version 1. See the FHIR Consent resources in the Cloud Healthcare API guide for more details. |
| Name | Value | Description |
|---|
| CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED | CONSENT_ENFORCEMENT_VERSION_UNSPECIFIED | Users must specify an enforcement version or an error is returned. |
| V1 | V1 | Enforcement version 1. See the FHIR Consent resources in the Cloud Healthcare API guide for more details. |
ConsentHeaderHandling, ConsentHeaderHandlingArgs
How the server handles the consent header.
- Profile
ConsentHeaderHandlingProfile
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE option is used.
- profile
ConsentHeaderHandlingProfile
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE option is used.
- profile
ConsentHeaderHandlingProfile
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE option is used.
- profile
ConsentHeaderHandlingProfile
- Optional. Specifies the default server behavior when the header is empty. If not specified, the
ScopeProfile.PERMIT_EMPTY_SCOPE option is used.
ConsentHeaderHandlingProfile
Optional. Specifies the default server behavior when the header is empty. If not specified, the ScopeProfile.PERMIT_EMPTY_SCOPE option is used.
| Name | Value | Description |
|---|
| ScopeProfileUnspecified | SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
| PermitEmptyScope | PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
| RequiredOnRead | REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
| Name | Value | Description |
|---|
| ConsentHeaderHandlingProfileScopeProfileUnspecified | SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
| ConsentHeaderHandlingProfilePermitEmptyScope | PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
| ConsentHeaderHandlingProfileRequiredOnRead | REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
| Value | Description |
|---|
SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
| Name | Value | Description |
|---|
| ScopeProfileUnspecified | SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
| PermitEmptyScope | PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
| RequiredOnRead | REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
| Name | Value | Description |
|---|
| ScopeProfileUnspecified | SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
| PermitEmptyScope | PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
| RequiredOnRead | REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
| Name | Value | Description |
|---|
| SCOPE_PROFILE_UNSPECIFIED | SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
| PERMIT_EMPTY_SCOPE | PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
| REQUIRED_ON_READ | REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
| Value | Description |
|---|
SCOPE_PROFILE_UNSPECIFIED | If not specified, the default value PERMIT_EMPTY_SCOPE is used. |
PERMIT_EMPTY_SCOPE | When no consent scopes are provided (for example, if there's an empty or missing header), then consent check is disabled, similar to when access_enforced is false. You can use audit logs to differentiate these two cases by looking at the value of protopayload.metadata.consentMode. If consents scopes are present, they must be valid and within the allowed limits, otherwise the request will be rejected with a 4xx code. |
REQUIRED_ON_READ | The consent header must be non-empty when performing read and search operations, otherwise the request is rejected with a 4xx code. Additionally, invalid consent scopes or scopes exceeding the allowed limits are rejected. |
ConsentHeaderHandlingResponse
How the server handles the consent header.
- 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
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.
CryptoHashConfig, CryptoHashConfigArgs
Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=.
- CryptoKey
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.
- KmsWrapped
KmsWrappedCryptoKey
- 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
object
- KMS wrapped key. Must not be set if crypto_key is set.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKey
- KMS wrapped key. Must not be set if crypto_key is set.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKey
- 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
KmsWrappedCryptoKey
- KMS wrapped key. Must not be set if crypto_key is set.
- cryptoKey
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.
- kmsWrapped
Property Map
- KMS wrapped key. Must not be set if crypto_key is set.
CryptoHashConfigResponse
Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=.
- CryptoKey
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.
- KmsWrapped
KmsWrappedCryptoKeyResponse
- 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
object
- KMS wrapped key. Must not be set if crypto_key is set.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKeyResponse
- KMS wrapped key. Must not be set if crypto_key is set.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKeyResponse
- 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
KmsWrappedCryptoKeyResponse
- KMS wrapped key. Must not be set if crypto_key is set.
- cryptoKey
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.
- kmsWrapped
Property Map
- KMS wrapped key. Must not be set if crypto_key is set.
DateShiftConfig, DateShiftConfigArgs
Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.
- CryptoKey
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.
- KmsWrapped
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.KmsWrappedCryptoKey
- 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.
- CryptoKey
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.
- KmsWrapped
KmsWrappedCryptoKey
- 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
object
- 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.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKey
- 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.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKey
- 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
KmsWrappedCryptoKey
- 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.
- cryptoKey
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.
- kmsWrapped
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.
DateShiftConfigResponse
Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.
- CryptoKey
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.
- KmsWrapped
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.KmsWrappedCryptoKeyResponse
- 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.
- CryptoKey
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.
- KmsWrapped
KmsWrappedCryptoKeyResponse
- 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
object
- 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.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKeyResponse
- 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.
- cryptoKey
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.
- kmsWrapped
KmsWrappedCryptoKeyResponse
- 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
KmsWrappedCryptoKeyResponse
- 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.
- cryptoKey
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.
- kmsWrapped
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.
DeidentifiedStoreDestination, DeidentifiedStoreDestinationArgs
Contains configuration for streaming de-identified FHIR export.
- Config
DeidentifyConfig
- 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
object
- 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
DeidentifyConfig
- 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
DeidentifyConfig
- 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
DeidentifyConfig
- 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}.
DeidentifiedStoreDestinationResponse
Contains configuration for streaming de-identified FHIR export.
- Config
DeidentifyConfigResponse
- 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
object
- 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
DeidentifyConfigResponse
- 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
DeidentifyConfigResponse
- 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
DeidentifyConfigResponse
- 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}.
DeidentifyConfig, DeidentifyConfigArgs
Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime.
- Annotation
AnnotationConfig
- 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
DicomConfig
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- DicomTagConfig
DicomTagConfig
- Configures de-id of application/DICOM content.
- Fhir
FhirConfig
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- FhirFieldConfig
FhirFieldConfig
- Configures de-id of application/FHIR content.
- Image
ImageConfig
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- OperationMetadata
DeidentifyOperationMetadata
- Details about the work the de-identify operation performed.
- Text
TextConfig
- Configures de-identification of text wherever it is found in the source_dataset.
- UseRegionalDataProcessing
bool
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
object
- 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
object
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicom_tag_config
object
- Configures de-id of application/DICOM content.
- fhir
object
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhir_field_config
object
- Configures de-id of application/FHIR content.
- image
object
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operation_metadata
object
- Details about the work the de-identify operation performed.
- text
object
- Configures de-identification of text wherever it is found in the source_dataset.
- use_regional_data_processing
bool
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
AnnotationConfig
- 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
DicomConfig
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicomTagConfig
DicomTagConfig
- Configures de-id of application/DICOM content.
- fhir
FhirConfig
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhirFieldConfig
FhirFieldConfig
- Configures de-id of application/FHIR content.
- image
ImageConfig
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operationMetadata
DeidentifyOperationMetadata
- Details about the work the de-identify operation performed.
- text
TextConfig
- Configures de-identification of text wherever it is found in the source_dataset.
- useRegionalDataProcessing
Boolean
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
AnnotationConfig
- 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
DicomConfig
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicomTagConfig
DicomTagConfig
- Configures de-id of application/DICOM content.
- fhir
FhirConfig
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhirFieldConfig
FhirFieldConfig
- Configures de-id of application/FHIR content.
- image
ImageConfig
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operationMetadata
DeidentifyOperationMetadata
- Details about the work the de-identify operation performed.
- text
TextConfig
- Configures de-identification of text wherever it is found in the source_dataset.
- useRegionalDataProcessing
boolean
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
AnnotationConfig
- 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
DicomConfig
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicom_tag_config
DicomTagConfig
- Configures de-id of application/DICOM content.
- fhir
FhirConfig
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhir_field_config
FhirFieldConfig
- Configures de-id of application/FHIR content.
- image
ImageConfig
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operation_metadata
DeidentifyOperationMetadata
- Details about the work the de-identify operation performed.
- text
TextConfig
- Configures de-identification of text wherever it is found in the source_dataset.
- use_regional_data_processing
bool
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION 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.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicomTagConfig
Property Map
- Configures de-id of application/DICOM content.
- fhir
Property Map
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhirFieldConfig
Property Map
- 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.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operationMetadata
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.
- useRegionalDataProcessing
Boolean
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
DeidentifyConfigResponse
Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime.
- Annotation
AnnotationConfigResponse
- 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
DicomConfigResponse
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- DicomTagConfig
DicomTagConfigResponse
- Configures de-id of application/DICOM content.
- Fhir
FhirConfigResponse
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- FhirFieldConfig
FhirFieldConfigResponse
- Configures de-id of application/FHIR content.
- Image
ImageConfigResponse
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- OperationMetadata
DeidentifyOperationMetadataResponse
- Details about the work the de-identify operation performed.
- Text
TextConfigResponse
- Configures de-identification of text wherever it is found in the source_dataset.
- UseRegionalDataProcessing
bool
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
object
- 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
object
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicom_tag_config
object
- Configures de-id of application/DICOM content.
- fhir
object
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhir_field_config
object
- Configures de-id of application/FHIR content.
- image
object
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operation_metadata
object
- Details about the work the de-identify operation performed.
- text
object
- Configures de-identification of text wherever it is found in the source_dataset.
- use_regional_data_processing
bool
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
AnnotationConfigResponse
- 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
DicomConfigResponse
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicomTagConfig
DicomTagConfigResponse
- Configures de-id of application/DICOM content.
- fhir
FhirConfigResponse
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhirFieldConfig
FhirFieldConfigResponse
- Configures de-id of application/FHIR content.
- image
ImageConfigResponse
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operationMetadata
DeidentifyOperationMetadataResponse
- Details about the work the de-identify operation performed.
- text
TextConfigResponse
- Configures de-identification of text wherever it is found in the source_dataset.
- useRegionalDataProcessing
Boolean
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
AnnotationConfigResponse
- 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
DicomConfigResponse
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicomTagConfig
DicomTagConfigResponse
- Configures de-id of application/DICOM content.
- fhir
FhirConfigResponse
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhirFieldConfig
FhirFieldConfigResponse
- Configures de-id of application/FHIR content.
- image
ImageConfigResponse
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operationMetadata
DeidentifyOperationMetadataResponse
- Details about the work the de-identify operation performed.
- text
TextConfigResponse
- Configures de-identification of text wherever it is found in the source_dataset.
- useRegionalDataProcessing
boolean
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
- annotation
AnnotationConfigResponse
- 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
DicomConfigResponse
- Configures de-id of application/DICOM content. Deprecated. Use
dicom_tag_config instead.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicom_tag_config
DicomTagConfigResponse
- Configures de-id of application/DICOM content.
- fhir
FhirConfigResponse
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhir_field_config
FhirFieldConfigResponse
- Configures de-id of application/FHIR content.
- image
ImageConfigResponse
- Configures the de-identification of image pixels in the source_dataset. Deprecated. Use
dicom_tag_config.options.clean_image instead.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operation_metadata
DeidentifyOperationMetadataResponse
- Details about the work the de-identify operation performed.
- text
TextConfigResponse
- Configures de-identification of text wherever it is found in the source_dataset.
- use_regional_data_processing
bool
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION 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.Deprecated: Configures de-id of application/DICOM content. Deprecated. Use dicom_tag_config instead.
- dicomTagConfig
Property Map
- Configures de-id of application/DICOM content.
- fhir
Property Map
- Configures de-id of application/FHIR content. Deprecated. Use
fhir_field_config instead.Deprecated: Configures de-id of application/FHIR content. Deprecated. Use fhir_field_config instead.
- fhirFieldConfig
Property Map
- 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.Deprecated: Configures the de-identification of image pixels in the source_dataset. Deprecated. Use dicom_tag_config.options.clean_image instead.
- operationMetadata
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.
- useRegionalDataProcessing
Boolean
- 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 or ORGANIZATION_NAME infoTypes. If the deprecated DicomConfig or FhirConfig are used, then LOCATION must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.
Details about the work the de-identify operation performed.
Details about the work the de-identify operation performed.
DicomConfig, DicomConfigArgs
Specifies the parameters needed for de-identification of DICOM stores.
- FilterProfile
DicomConfigFilterProfile
- Tag filtering profile that determines which tags to keep/remove.
- KeepList
TagFilterList
- List of tags to keep. Remove all other tags.
- RemoveList
TagFilterList
- List of tags to remove. Keep all other tags.
- SkipIdRedaction
bool
- 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
- filterProfile
DicomConfigFilterProfile
- Tag filtering profile that determines which tags to keep/remove.
- keepList
TagFilterList
- List of tags to keep. Remove all other tags.
- removeList
TagFilterList
- List of tags to remove. Keep all other tags.
- skipIdRedaction
Boolean
- 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
- filterProfile
DicomConfigFilterProfile
- Tag filtering profile that determines which tags to keep/remove.
- keepList
TagFilterList
- List of tags to keep. Remove all other tags.
- removeList
TagFilterList
- List of tags to remove. Keep all other tags.
- skipIdRedaction
boolean
- 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
DicomConfigFilterProfile
- Tag filtering profile that determines which tags to keep/remove.
- keep_list
TagFilterList
- List of tags to keep. Remove all other tags.
- remove_list
TagFilterList
- List of tags to remove. Keep all other tags.
- skip_id_redaction
bool
- 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
DicomConfigFilterProfile
Tag filtering profile that determines which tags to keep/remove.
| Name | Value | Description |
|---|
| TagFilterProfileUnspecified | TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
| MinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| AttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
| KeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| DicomConfigFilterProfileTagFilterProfileUnspecified | TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
| DicomConfigFilterProfileMinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| DicomConfigFilterProfileAttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
| DicomConfigFilterProfileKeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DicomConfigFilterProfileDeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Value | Description |
|---|
TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
KEEP_ALL_PROFILE | Keep all tags. |
DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| TagFilterProfileUnspecified | TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
| MinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| AttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
| KeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| TagFilterProfileUnspecified | TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
| MinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| AttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
| KeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| TAG_FILTER_PROFILE_UNSPECIFIED | TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
| MINIMAL_KEEP_LIST_PROFILE | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
| KEEP_ALL_PROFILE | KEEP_ALL_PROFILE | Keep all tags. |
| DEIDENTIFY_TAG_CONTENTS | DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Value | Description |
|---|
TAG_FILTER_PROFILE_UNSPECIFIED | No tag filtration profile provided. Same as KEEP_ALL_PROFILE. |
MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e) http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html. |
KEEP_ALL_PROFILE | Keep all tags. |
DEIDENTIFY_TAG_CONTENTS | Inspect within tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following Value Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
DicomConfigResponse
Specifies the parameters needed for de-identification of DICOM stores.
- FilterProfile
string
- Tag filtering profile that determines which tags to keep/remove.
- KeepList
TagFilterListResponse
- List of tags to keep. Remove all other tags.
- RemoveList
TagFilterListResponse
- List of tags to remove. Keep all other tags.
- SkipIdRedaction
bool
- 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
object
- List of tags to keep. Remove all other tags.
- remove_list
object
- List of tags to remove. Keep all other tags.
- skip_id_redaction
bool
- 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
- filterProfile
String
- Tag filtering profile that determines which tags to keep/remove.
- keepList
TagFilterListResponse
- List of tags to keep. Remove all other tags.
- removeList
TagFilterListResponse
- List of tags to remove. Keep all other tags.
- skipIdRedaction
Boolean
- 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
- filterProfile
string
- Tag filtering profile that determines which tags to keep/remove.
- keepList
TagFilterListResponse
- List of tags to keep. Remove all other tags.
- removeList
TagFilterListResponse
- List of tags to remove. Keep all other tags.
- skipIdRedaction
boolean
- 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
TagFilterListResponse
- List of tags to keep. Remove all other tags.
- remove_list
TagFilterListResponse
- List of tags to remove. Keep all other tags.
- skip_id_redaction
bool
- 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
- filterProfile
String
- Tag filtering profile that determines which tags to keep/remove.
- keepList
Property Map
- List of tags to keep. Remove all other tags.
- removeList
Property Map
- List of tags to remove. Keep all other tags.
- skipIdRedaction
Boolean
- 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
DicomTagConfig, DicomTagConfigArgs
Specifies the parameters needed for the de-identification of DICOM stores.
DicomTagConfigProfileType
Base profile type for handling DICOM tags.
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
| MinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| AttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
| KeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| DicomTagConfigProfileTypeProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
| DicomTagConfigProfileTypeMinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| DicomTagConfigProfileTypeAttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
| DicomTagConfigProfileTypeKeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DicomTagConfigProfileTypeDeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Value | Description |
|---|
PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
KEEP_ALL_PROFILE | Keep all tags. |
DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
| MinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| AttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
| KeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
| MinimalKeepListProfile | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| AttributeConfidentialityBasicProfile | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
| KeepAllProfile | KEEP_ALL_PROFILE | Keep all tags. |
| DeidentifyTagContents | DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Name | Value | Description |
|---|
| PROFILE_TYPE_UNSPECIFIED | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
| MINIMAL_KEEP_LIST_PROFILE | MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
| ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
| KEEP_ALL_PROFILE | KEEP_ALL_PROFILE | Keep all tags. |
| DEIDENTIFY_TAG_CONTENTS | DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
| Value | Description |
|---|
PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE. |
MINIMAL_KEEP_LIST_PROFILE | Keep only the tags required to produce valid DICOM objects. |
ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE | Remove tags based on DICOM Standard's Attribute Confidentiality Basic Profile (DICOM Standard Edition 2018e). |
KEEP_ALL_PROFILE | Keep all tags. |
DEIDENTIFY_TAG_CONTENTS | Inspect tag contents and replace sensitive text. The process can be configured using the TextConfig. Applies to all tags with the following [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS |
DicomTagConfigResponse
Specifies the parameters needed for the de-identification of DICOM stores.
- Actions
[]ActionResponse
- Specifies custom tag selections and
Actions to apply to them. Overrides options and profile. Conflicting Actions are applied in the order given. - Options
OptionsResponse
- Specifies additional options to apply, overriding the base
profile. - ProfileType
string
- Base profile type for handling DICOM tags.
- actions
list(object)
- Specifies custom tag selections and
Actions to apply to them. Overrides options and profile. Conflicting Actions are applied in the order given. - options
object
- Specifies additional options to apply, overriding the base
profile. - profile_type
string
- Base profile type for handling DICOM tags.
- actions
List<ActionResponse>
- Specifies custom tag selections and
Actions to apply to them. Overrides options and profile. Conflicting Actions are applied in the order given. - options
OptionsResponse
- Specifies additional options to apply, overriding the base
profile. - profileType
String
- Base profile type for handling DICOM tags.
- actions
ActionResponse[]
- Specifies custom tag selections and
Actions to apply to them. Overrides options and profile. Conflicting Actions are applied in the order given. - options
OptionsResponse
- Specifies additional options to apply, overriding the base
profile. - profileType
string
- Base profile type for handling DICOM tags.
- actions
List<Property Map>
- Specifies custom tag selections and
Actions to apply to them. Overrides options and profile. Conflicting Actions are applied in the order given. - options
Property Map
- Specifies additional options to apply, overriding the base
profile. - profileType
String
- Base profile type for handling DICOM tags.
FhirConfig, FhirConfigArgs
Specifies how to handle de-identification of a FHIR store.
- DefaultKeepExtensions
bool
- 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.
- FieldMetadataList
List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.FieldMetadata>
- 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.
- DefaultKeepExtensions
bool
- 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.
- FieldMetadataList
[]FieldMetadata
- 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_extensions
bool
- 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
list(object)
- 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.
- defaultKeepExtensions
Boolean
- 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.
- fieldMetadataList
List<FieldMetadata>
- 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.
- defaultKeepExtensions
boolean
- 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.
- fieldMetadataList
FieldMetadata[]
- 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_extensions
bool
- 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
Sequence[FieldMetadata]
- 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.
- defaultKeepExtensions
Boolean
- 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.
- fieldMetadataList
List<Property Map>
- 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.
FhirConfigResponse
Specifies how to handle de-identification of a FHIR store.
- DefaultKeepExtensions
bool
- 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.
- FieldMetadataList
List<Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.FieldMetadataResponse>
- 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.
- DefaultKeepExtensions
bool
- 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.
- FieldMetadataList
[]FieldMetadataResponse
- 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_extensions
bool
- 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
list(object)
- 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.
- defaultKeepExtensions
Boolean
- 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.
- fieldMetadataList
List<FieldMetadataResponse>
- 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.
- defaultKeepExtensions
boolean
- 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.
- fieldMetadataList
FieldMetadataResponse[]
- 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_extensions
bool
- 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
Sequence[FieldMetadataResponse]
- 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.
- defaultKeepExtensions
Boolean
- 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.
- fieldMetadataList
List<Property Map>
- 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.
FhirFieldConfig, FhirFieldConfigArgs
Specifies how to handle the de-identification of a FHIR store.
- field_metadata_list
list(object)
- 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 FieldMetadata action, the first action option is applied. Overrides options and the union field profile in FhirFieldConfig. - options
object
- Specifies additional options, overriding the base ProfileType.
- profile_type
"PROFILE_TYPE_UNSPECIFIED" | "KEEP_ALL" | "BASIC" | "CLEAN_ALL"
- Base profile type for handling FHIR fields.
FhirFieldConfigProfileType
Base profile type for handling FHIR fields.
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| KeepAll | KEEP_ALL | Keep all fields. |
| Basic | BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
| CleanAll | CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
| Name | Value | Description |
|---|
| FhirFieldConfigProfileTypeProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| FhirFieldConfigProfileTypeKeepAll | KEEP_ALL | Keep all fields. |
| FhirFieldConfigProfileTypeBasic | BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
| FhirFieldConfigProfileTypeCleanAll | CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
| Value | Description |
|---|
PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
KEEP_ALL | Keep all fields. |
BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| KeepAll | KEEP_ALL | Keep all fields. |
| Basic | BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
| CleanAll | CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| KeepAll | KEEP_ALL | Keep all fields. |
| Basic | BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
| CleanAll | CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
| Name | Value | Description |
|---|
| PROFILE_TYPE_UNSPECIFIED | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| KEEP_ALL | KEEP_ALL | Keep all fields. |
| BASIC | BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
| CLEAN_ALL | CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
| Value | Description |
|---|
PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
KEEP_ALL | Keep all fields. |
BASIC | Transforms known HIPAA 18 fields and cleans known unstructured text fields. |
CLEAN_ALL | Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. |
FhirFieldConfigResponse
Specifies how to handle the de-identification of a FHIR store.
- field_metadata_list
list(object)
- 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 FieldMetadata action, the first action option is applied. Overrides options and the union field profile in FhirFieldConfig. - options
object
- Specifies additional options, overriding the base ProfileType.
- profile_type
string
- Base profile type for handling FHIR fields.
- fieldMetadataList
List<Property Map>
- 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 FieldMetadata action, the first action option is applied. Overrides options and the union field profile in FhirFieldConfig. - options
Property Map
- Specifies additional options, overriding the base ProfileType.
- profileType
String
- Base profile type for handling FHIR fields.
FhirNotificationConfig, FhirNotificationConfigArgs
Contains the configuration for FHIR notifications.
- PubsubTopic
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. - SendFullResource
bool
- 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.
- SendPreviousResourceOnDelete
bool
- 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.
- PubsubTopic
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. - SendFullResource
bool
- 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.
- SendPreviousResourceOnDelete
bool
- 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_resource
bool
- 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_resource_on_delete
bool
- 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.
- pubsubTopic
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. - sendFullResource
Boolean
- 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.
- sendPreviousResourceOnDelete
Boolean
- 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.
- pubsubTopic
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. - sendFullResource
boolean
- 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.
- sendPreviousResourceOnDelete
boolean
- 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_resource
bool
- 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_resource_on_delete
bool
- 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.
- pubsubTopic
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. - sendFullResource
Boolean
- 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.
- sendPreviousResourceOnDelete
Boolean
- 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.
FhirNotificationConfigResponse
Contains the configuration for FHIR notifications.
- PubsubTopic
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. - SendFullResource
bool
- 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.
- SendPreviousResourceOnDelete
bool
- 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.
- PubsubTopic
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. - SendFullResource
bool
- 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.
- SendPreviousResourceOnDelete
bool
- 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_resource
bool
- 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_resource_on_delete
bool
- 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.
- pubsubTopic
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. - sendFullResource
Boolean
- 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.
- sendPreviousResourceOnDelete
Boolean
- 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.
- pubsubTopic
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. - sendFullResource
boolean
- 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.
- sendPreviousResourceOnDelete
boolean
- 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_resource
bool
- 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_resource_on_delete
bool
- 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.
- pubsubTopic
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. - sendFullResource
Boolean
- 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.
- sendPreviousResourceOnDelete
Boolean
- 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.
FhirOutput, FhirOutputArgs
Details about the FHIR store to write the output to.
- FhirStore
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.
- FhirStore
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.
- fhirStore
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.
- fhirStore
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.
- fhirStore
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.
FhirOutputResponse
Details about the FHIR store to write the output to.
- FhirStore
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.
- FhirStore
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.
- fhirStore
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.
- fhirStore
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.
- fhirStore
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.
FhirStoreComplexDataTypeReferenceParsing
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.
| Name | Value | Description |
|---|
| ComplexDataTypeReferenceParsingUnspecified | COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
| Disabled | DISABLED | References in complex data types are ignored. |
| Enabled | ENABLED | References in complex data types are parsed. |
| Name | Value | Description |
|---|
| FhirStoreComplexDataTypeReferenceParsingComplexDataTypeReferenceParsingUnspecified | COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
| FhirStoreComplexDataTypeReferenceParsingDisabled | DISABLED | References in complex data types are ignored. |
| FhirStoreComplexDataTypeReferenceParsingEnabled | ENABLED | References in complex data types are parsed. |
| Value | Description |
|---|
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
DISABLED | References in complex data types are ignored. |
ENABLED | References in complex data types are parsed. |
| Name | Value | Description |
|---|
| ComplexDataTypeReferenceParsingUnspecified | COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
| Disabled | DISABLED | References in complex data types are ignored. |
| Enabled | ENABLED | References in complex data types are parsed. |
| Name | Value | Description |
|---|
| ComplexDataTypeReferenceParsingUnspecified | COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
| Disabled | DISABLED | References in complex data types are ignored. |
| Enabled | ENABLED | References in complex data types are parsed. |
| Name | Value | Description |
|---|
| COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
| DISABLED | DISABLED | References in complex data types are ignored. |
| ENABLED | ENABLED | References in complex data types are parsed. |
| Value | Description |
|---|
COMPLEX_DATA_TYPE_REFERENCE_PARSING_UNSPECIFIED | No parsing behavior specified. This is the same as DISABLED for backwards compatibility. |
DISABLED | References in complex data types are ignored. |
ENABLED | References in complex data types are parsed. |
FhirStoreVersion
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.
| Name | Value | Description |
|---|
| VersionUnspecified | VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
| Dstu2 | DSTU2 | Draft Standard for Trial Use, Release 2 |
| Stu3 | STU3 | Standard for Trial Use, Release 3 |
| R4 | R4 | Release 4 |
| Name | Value | Description |
|---|
| FhirStoreVersionVersionUnspecified | VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
| FhirStoreVersionDstu2 | DSTU2 | Draft Standard for Trial Use, Release 2 |
| FhirStoreVersionStu3 | STU3 | Standard for Trial Use, Release 3 |
| FhirStoreVersionR4 | R4 | Release 4 |
| Value | Description |
|---|
VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
DSTU2 | Draft Standard for Trial Use, Release 2 |
STU3 | Standard for Trial Use, Release 3 |
R4 | Release 4 |
| Name | Value | Description |
|---|
| VersionUnspecified | VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
| Dstu2 | DSTU2 | Draft Standard for Trial Use, Release 2 |
| Stu3 | STU3 | Standard for Trial Use, Release 3 |
| R4 | R4 | Release 4 |
| Name | Value | Description |
|---|
| VersionUnspecified | VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
| Dstu2 | DSTU2 | Draft Standard for Trial Use, Release 2 |
| Stu3 | STU3 | Standard for Trial Use, Release 3 |
| R4 | R4 | Release 4 |
| Name | Value | Description |
|---|
| VERSION_UNSPECIFIED | VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
| DSTU2 | DSTU2 | Draft Standard for Trial Use, Release 2 |
| STU3 | STU3 | Standard for Trial Use, Release 3 |
| R4 | R4 | Release 4 |
| Value | Description |
|---|
VERSION_UNSPECIFIED | VERSION_UNSPECIFIED is treated as STU3 to accommodate the existing FHIR stores. |
DSTU2 | Draft Standard for Trial Use, Release 2 |
STU3 | Standard for Trial Use, Release 3 |
R4 | Release 4 |
Specifies FHIR paths to match, and how to handle de-identification of matching fields.
- Action
Pulumi.GoogleNative.Healthcare.V1Beta1.FieldMetadataAction
- 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
FieldMetadataAction
- 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
"ACTION_UNSPECIFIED" | "TRANSFORM" | "INSPECT_AND_TRANSFORM" | "DO_NOT_TRANSFORM"
- 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
FieldMetadataAction
- 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
FieldMetadataAction
- 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
FieldMetadataAction
- 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
"ACTION_UNSPECIFIED" | "TRANSFORM" | "INSPECT_AND_TRANSFORM" | "DO_NOT_TRANSFORM"
- 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.
Deidentify action for one field.
| Name | Value | Description |
|---|
| ActionUnspecified | ACTION_UNSPECIFIED | No action specified. |
| Transform | TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
| InspectAndTransform | INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
| DoNotTransform | DO_NOT_TRANSFORM | Do not transform. |
| Name | Value | Description |
|---|
| FieldMetadataActionActionUnspecified | ACTION_UNSPECIFIED | No action specified. |
| FieldMetadataActionTransform | TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
| FieldMetadataActionInspectAndTransform | INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
| FieldMetadataActionDoNotTransform | DO_NOT_TRANSFORM | Do not transform. |
| Value | Description |
|---|
ACTION_UNSPECIFIED | No action specified. |
TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
DO_NOT_TRANSFORM | Do not transform. |
| Name | Value | Description |
|---|
| ActionUnspecified | ACTION_UNSPECIFIED | No action specified. |
| Transform | TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
| InspectAndTransform | INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
| DoNotTransform | DO_NOT_TRANSFORM | Do not transform. |
| Name | Value | Description |
|---|
| ActionUnspecified | ACTION_UNSPECIFIED | No action specified. |
| Transform | TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
| InspectAndTransform | INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
| DoNotTransform | DO_NOT_TRANSFORM | Do not transform. |
| Name | Value | Description |
|---|
| ACTION_UNSPECIFIED | ACTION_UNSPECIFIED | No action specified. |
| TRANSFORM | TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
| INSPECT_AND_TRANSFORM | INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
| DO_NOT_TRANSFORM | DO_NOT_TRANSFORM | Do not transform. |
| Value | Description |
|---|
ACTION_UNSPECIFIED | No action specified. |
TRANSFORM | Transform the entire field based on transformations specified in TextConfig. When the specified transformation cannot be applied to a field, RedactConfig is used. For example, a Crypto Hash transformation can't be applied to a FHIR Date field. |
INSPECT_AND_TRANSFORM | Inspect and transform any found PHI. When AnnotationConfig is provided, annotations of PHI will be generated, except for Date and Datetime. |
DO_NOT_TRANSFORM | Do not transform. |
Specifies FHIR paths to match, and how to handle de-identification of matching fields.
- 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
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.
Specifies the FHIR paths to match and how to handle the de-identification of matching fields.
- CharacterMaskField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CharacterMaskField
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- CleanTextField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CleanTextField
- 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.
- CryptoHashField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CryptoHashField
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- DateShiftField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.DateShiftField
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- KeepField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.KeepField
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - RemoveField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RemoveField
- Remove the field.
- CharacterMaskField
CharacterMaskField
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- CleanTextField
CleanTextField
- 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.
- CryptoHashField
CryptoHashField
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- DateShiftField
DateShiftField
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- KeepField
KeepField
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - RemoveField
RemoveField
- Remove the field.
- character_mask_field
object
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean_text_field
object
- 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_field
object
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date_shift_field
object
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep_field
object
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - remove_field
object
- Remove the field.
- characterMaskField
CharacterMaskField
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- cleanTextField
CleanTextField
- 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.
- cryptoHashField
CryptoHashField
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- dateShiftField
DateShiftField
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keepField
KeepField
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - removeField
RemoveField
- Remove the field.
- characterMaskField
CharacterMaskField
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- cleanTextField
CleanTextField
- 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.
- cryptoHashField
CryptoHashField
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- dateShiftField
DateShiftField
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keepField
KeepField
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - removeField
RemoveField
- Remove the field.
- character_mask_field
CharacterMaskField
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean_text_field
CleanTextField
- 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_field
CryptoHashField
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date_shift_field
DateShiftField
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep_field
KeepField
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - remove_field
RemoveField
- Remove the field.
- characterMaskField
Property Map
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- cleanTextField
Property Map
- 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.
- cryptoHashField
Property Map
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- dateShiftField
Property Map
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keepField
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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - removeField
Property Map
- Remove the field.
Specifies the FHIR paths to match and how to handle the de-identification of matching fields.
- CharacterMaskField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CharacterMaskFieldResponse
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- CleanTextField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CleanTextFieldResponse
- 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.
- CryptoHashField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.CryptoHashFieldResponse
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- DateShiftField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.DateShiftFieldResponse
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- KeepField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.KeepFieldResponse
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - RemoveField
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.RemoveFieldResponse
- Remove the field.
- CharacterMaskField
CharacterMaskFieldResponse
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- CleanTextField
CleanTextFieldResponse
- 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.
- CryptoHashField
CryptoHashFieldResponse
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- DateShiftField
DateShiftFieldResponse
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- KeepField
KeepFieldResponse
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - RemoveField
RemoveFieldResponse
- Remove the field.
- character_mask_field
object
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean_text_field
object
- 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_field
object
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date_shift_field
object
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep_field
object
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - remove_field
object
- Remove the field.
- characterMaskField
CharacterMaskFieldResponse
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- cleanTextField
CleanTextFieldResponse
- 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.
- cryptoHashField
CryptoHashFieldResponse
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- dateShiftField
DateShiftFieldResponse
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keepField
KeepFieldResponse
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - removeField
RemoveFieldResponse
- Remove the field.
- characterMaskField
CharacterMaskFieldResponse
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- cleanTextField
CleanTextFieldResponse
- 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.
- cryptoHashField
CryptoHashFieldResponse
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- dateShiftField
DateShiftFieldResponse
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keepField
KeepFieldResponse
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - removeField
RemoveFieldResponse
- Remove the field.
- character_mask_field
CharacterMaskFieldResponse
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- clean_text_field
CleanTextFieldResponse
- 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_field
CryptoHashFieldResponse
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- date_shift_field
DateShiftFieldResponse
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keep_field
KeepFieldResponse
- 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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - remove_field
RemoveFieldResponse
- Remove the field.
- characterMaskField
Property Map
- Replace the field's value with a masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- cleanTextField
Property Map
- 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.
- cryptoHashField
Property Map
- Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
- dateShiftField
Property Map
- Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime.
- keepField
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 by Patient.Address.String. Partial matching is supported. For example, Patient.Address.city can be matched by Address.city (with 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 format field[x]), use two separate components. For example, deceasedAge.unit is matched by Deceased.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 example HumanName.given, HumanName.family) can be omitted. - removeField
Property Map
- Remove the field.
GoogleCloudHealthcareV1beta1DeidentifyOptions, GoogleCloudHealthcareV1beta1DeidentifyOptionsArgs
Specifies additional options to apply to the base ProfileType.
GoogleCloudHealthcareV1beta1DeidentifyOptionsResponse
Specifies additional options to apply to the base ProfileType.
GoogleCloudHealthcareV1beta1FhirBigQueryDestination, GoogleCloudHealthcareV1beta1FhirBigQueryDestinationArgs
The configuration for exporting to BigQuery.
- DatasetUri
string
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - Force
bool
- Use
write_disposition instead. If write_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. - SchemaConfig
SchemaConfig
- The configuration for the exported BigQuery schema.
- WriteDisposition
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition
- 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. If write_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
object
- The configuration for the exported BigQuery schema.
- write_disposition
"WRITE_DISPOSITION_UNSPECIFIED" | "WRITE_EMPTY" | "WRITE_TRUNCATE" | "WRITE_APPEND"
- 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.
- datasetUri
String
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - force
Boolean
- Use
write_disposition instead. If write_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. - schemaConfig
SchemaConfig
- The configuration for the exported BigQuery schema.
- writeDisposition
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition
- 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.
- datasetUri
string
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - force
boolean
- Use
write_disposition instead. If write_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. - schemaConfig
SchemaConfig
- The configuration for the exported BigQuery schema.
- writeDisposition
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition
- 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. If write_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
- The configuration for the exported BigQuery schema.
- write_disposition
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition
- 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.
- datasetUri
String
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - force
Boolean
- Use
write_disposition instead. If write_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. - schemaConfig
Property Map
- The configuration for the exported BigQuery schema.
- writeDisposition
"WRITE_DISPOSITION_UNSPECIFIED" | "WRITE_EMPTY" | "WRITE_TRUNCATE" | "WRITE_APPEND"
- 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.
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
The configuration for exporting to BigQuery.
- DatasetUri
string
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - Force
bool
- Use
write_disposition instead. If write_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. - SchemaConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.SchemaConfigResponse
- The configuration for the exported BigQuery schema.
- WriteDisposition
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.
- DatasetUri
string
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - Force
bool
- Use
write_disposition instead. If write_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. - SchemaConfig
SchemaConfigResponse
- The configuration for the exported BigQuery schema.
- WriteDisposition
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. If write_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
object
- 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.
- datasetUri
String
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - force
Boolean
- Use
write_disposition instead. If write_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. - schemaConfig
SchemaConfigResponse
- The configuration for the exported BigQuery schema.
- writeDisposition
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.
- datasetUri
string
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - force
boolean
- Use
write_disposition instead. If write_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. - schemaConfig
SchemaConfigResponse
- The configuration for the exported BigQuery schema.
- writeDisposition
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. If write_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
SchemaConfigResponse
- 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.
- datasetUri
String
- BigQuery URI to an existing dataset, up to 2000 characters long, in the format
bq://projectId.bqDatasetId. - force
Boolean
- Use
write_disposition instead. If write_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. - schemaConfig
Property Map
- The configuration for the exported BigQuery schema.
- writeDisposition
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.
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDisposition
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.
| Name | Value | Description |
|---|
| WriteDispositionUnspecified | WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
| WriteEmpty | WRITE_EMPTY | Only export data if the destination tables are empty. |
| WriteTruncate | WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
| WriteAppend | WRITE_APPEND | Append data to the destination tables. |
| Name | Value | Description |
|---|
| GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDispositionWriteDispositionUnspecified | WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
| GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDispositionWriteEmpty | WRITE_EMPTY | Only export data if the destination tables are empty. |
| GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDispositionWriteTruncate | WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
| GoogleCloudHealthcareV1beta1FhirBigQueryDestinationWriteDispositionWriteAppend | WRITE_APPEND | Append data to the destination tables. |
| Value | Description |
|---|
WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
WRITE_EMPTY | Only export data if the destination tables are empty. |
WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
WRITE_APPEND | Append data to the destination tables. |
| Name | Value | Description |
|---|
| WriteDispositionUnspecified | WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
| WriteEmpty | WRITE_EMPTY | Only export data if the destination tables are empty. |
| WriteTruncate | WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
| WriteAppend | WRITE_APPEND | Append data to the destination tables. |
| Name | Value | Description |
|---|
| WriteDispositionUnspecified | WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
| WriteEmpty | WRITE_EMPTY | Only export data if the destination tables are empty. |
| WriteTruncate | WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
| WriteAppend | WRITE_APPEND | Append data to the destination tables. |
| Name | Value | Description |
|---|
| WRITE_DISPOSITION_UNSPECIFIED | WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
| WRITE_EMPTY | WRITE_EMPTY | Only export data if the destination tables are empty. |
| WRITE_TRUNCATE | WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
| WRITE_APPEND | WRITE_APPEND | Append data to the destination tables. |
| Value | Description |
|---|
WRITE_DISPOSITION_UNSPECIFIED | Default behavior is the same as WRITE_EMPTY. |
WRITE_EMPTY | Only export data if the destination tables are empty. |
WRITE_TRUNCATE | Erase all existing data in the destination tables before writing the FHIR resources. |
WRITE_APPEND | Append data to the destination tables. |
ImageConfig, ImageConfigArgs
Specifies how to handle de-identification of image pixels.
- AdditionalInfoTypes
List<string>
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - ExcludeInfoTypes
List<string>
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - TextRedactionMode
Pulumi.GoogleNative.Healthcare.V1Beta1.ImageConfigTextRedactionMode
- Determines how to redact text from image.
- AdditionalInfoTypes
[]string
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - ExcludeInfoTypes
[]string
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - TextRedactionMode
ImageConfigTextRedactionMode
- Determines how to redact text from image.
- additionalInfoTypes
List<String>
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - excludeInfoTypes
List<String>
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - textRedactionMode
ImageConfigTextRedactionMode
- Determines how to redact text from image.
- additionalInfoTypes
string[]
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - excludeInfoTypes
string[]
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - textRedactionMode
ImageConfigTextRedactionMode
- Determines how to redact text from image.
- additional_info_types
Sequence[str]
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - exclude_info_types
Sequence[str]
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - text_redaction_mode
ImageConfigTextRedactionMode
- Determines how to redact text from image.
ImageConfigResponse
Specifies how to handle de-identification of image pixels.
- AdditionalInfoTypes
List<string>
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - ExcludeInfoTypes
List<string>
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - TextRedactionMode
string
- Determines how to redact text from image.
- AdditionalInfoTypes
[]string
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - ExcludeInfoTypes
[]string
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - TextRedactionMode
string
- Determines how to redact text from image.
- additional_info_types
list(string)
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - exclude_info_types
list(string)
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - text_redaction_mode
string
- Determines how to redact text from image.
- additionalInfoTypes
List<String>
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - excludeInfoTypes
List<String>
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - textRedactionMode
String
- Determines how to redact text from image.
- additionalInfoTypes
string[]
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - excludeInfoTypes
string[]
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - textRedactionMode
string
- Determines how to redact text from image.
- additional_info_types
Sequence[str]
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - exclude_info_types
Sequence[str]
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - text_redaction_mode
str
- Determines how to redact text from image.
- additionalInfoTypes
List<String>
- Additional InfoTypes to redact in the images in addition to those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT, REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS or TEXT_REDACTION_MODE_UNSPECIFIED. - excludeInfoTypes
List<String>
- InfoTypes to skip redacting, overriding those used by
text_redaction_mode. Can only be used when text_redaction_mode is set to REDACT_SENSITIVE_TEXT or REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS. - textRedactionMode
String
- Determines how to redact text from image.
ImageConfigTextRedactionMode
Determines how to redact text from image.
| Name | Value | Description |
|---|
| TextRedactionModeUnspecified | TEXT_REDACTION_MODE_UNSPECIFIED | No text redaction specified. Same as REDACT_NO_TEXT. |
| RedactAllText | REDACT_ALL_TEXT | Redact all text. |
| RedactSensitiveText | REDACT_SENSITIVE_TEXT | Redact sensitive text. Uses the set of Default DICOM InfoTypes. |
| RedactNoText | REDACT_NO_TEXT | Do not redact text. |
| RedactSensitiveTextCleanDescriptors | REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS | This mode is like REDACT_SENSITIVE_TEXT with the addition of the [Clean Descriptors Option] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html) enabled: When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This mode uses an additional InfoType during inspection. |
| Name | Value | Description |
|---|
| ImageConfigTextRedactionModeTextRedactionModeUnspecified | TEXT_REDACTION_MODE_UNSPECIFIED | No text redaction specified. Same as REDACT_NO_TEXT. |
| ImageConfigTextRedactionModeRedactAllText | REDACT_ALL_TEXT | Redact all text. |
| ImageConfigTextRedactionModeRedactSensitiveText | REDACT_SENSITIVE_TEXT | Redact sensitive text. Uses the set of Default DICOM InfoTypes. |
| ImageConfigTextRedactionModeRedactNoText | REDACT_NO_TEXT | Do not redact text. |
| ImageConfigTextRedactionModeRedactSensitiveTextCleanDescriptors | REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS | This mode is like REDACT_SENSITIVE_TEXT with the addition of the [Clean Descriptors Option] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html) enabled: When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This mode uses an additional InfoType during inspection. |
| Name | Value | Description |
|---|
| TextRedactionModeUnspecified | TEXT_REDACTION_MODE_UNSPECIFIED | No text redaction specified. Same as REDACT_NO_TEXT. |
| RedactAllText | REDACT_ALL_TEXT | Redact all text. |
| RedactSensitiveText | REDACT_SENSITIVE_TEXT | Redact sensitive text. Uses the set of Default DICOM InfoTypes. |
| RedactNoText | REDACT_NO_TEXT | Do not redact text. |
| RedactSensitiveTextCleanDescriptors | REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS | This mode is like REDACT_SENSITIVE_TEXT with the addition of the [Clean Descriptors Option] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html) enabled: When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This mode uses an additional InfoType during inspection. |
| Name | Value | Description |
|---|
| TextRedactionModeUnspecified | TEXT_REDACTION_MODE_UNSPECIFIED | No text redaction specified. Same as REDACT_NO_TEXT. |
| RedactAllText | REDACT_ALL_TEXT | Redact all text. |
| RedactSensitiveText | REDACT_SENSITIVE_TEXT | Redact sensitive text. Uses the set of Default DICOM InfoTypes. |
| RedactNoText | REDACT_NO_TEXT | Do not redact text. |
| RedactSensitiveTextCleanDescriptors | REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS | This mode is like REDACT_SENSITIVE_TEXT with the addition of the [Clean Descriptors Option] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html) enabled: When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This mode uses an additional InfoType during inspection. |
| Name | Value | Description |
|---|
| TEXT_REDACTION_MODE_UNSPECIFIED | TEXT_REDACTION_MODE_UNSPECIFIED | No text redaction specified. Same as REDACT_NO_TEXT. |
| REDACT_ALL_TEXT | REDACT_ALL_TEXT | Redact all text. |
| REDACT_SENSITIVE_TEXT | REDACT_SENSITIVE_TEXT | Redact sensitive text. Uses the set of Default DICOM InfoTypes. |
| REDACT_NO_TEXT | REDACT_NO_TEXT | Do not redact text. |
| REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS | REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS | This mode is like REDACT_SENSITIVE_TEXT with the addition of the [Clean Descriptors Option] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html) enabled: When cleaning text, the process attempts to transform phrases matching any of the tags marked for removal (action codes D, Z, X, and U) in the [Basic Profile] (https://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html). These contextual phrases are replaced with the token "[CTX]". This mode uses an additional InfoType during inspection. |
A transformation to apply to text that is identified as a specific info_type.
A transformation to apply to text that is identified as a specific info_type.
KmsWrappedCryptoKey, KmsWrappedCryptoKeyArgs
Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. The key must grant the Cloud IAM permission cloudkms.cryptoKeyVersions.useToDecrypt to the project's Cloud Healthcare Service Agent service account. For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key).
- CryptoKey
string
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - WrappedKey
string
- The wrapped data crypto key.
- CryptoKey
string
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - WrappedKey
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.
- cryptoKey
String
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - wrappedKey
String
- The wrapped data crypto key.
- cryptoKey
string
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - wrappedKey
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.
- cryptoKey
String
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - wrappedKey
String
- The wrapped data crypto key.
KmsWrappedCryptoKeyResponse
Include to use an existing data crypto key wrapped by KMS. The wrapped key must be a 128-, 192-, or 256-bit key. The key must grant the Cloud IAM permission cloudkms.cryptoKeyVersions.useToDecrypt to the project's Cloud Healthcare Service Agent service account. For more information, see [Creating a wrapped key] (https://cloud.google.com/dlp/docs/create-wrapped-key).
- CryptoKey
string
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - WrappedKey
string
- The wrapped data crypto key.
- CryptoKey
string
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - WrappedKey
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.
- cryptoKey
String
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - wrappedKey
String
- The wrapped data crypto key.
- cryptoKey
string
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - wrappedKey
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.
- cryptoKey
String
- The resource name of the KMS CryptoKey to use for unwrapping. For example,
projects/{project_id}/locations/{location_id}/keyRings/{keyring}/cryptoKeys/{key}. - wrappedKey
String
- The wrapped data crypto key.
NotificationConfig, NotificationConfigArgs
Specifies where to send notifications upon changes to a data store.
- PubsubTopic
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.
- SendForBulkImport
bool
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- PubsubTopic
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.
- SendForBulkImport
bool
- 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_bulk_import
bool
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsubTopic
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.
- sendForBulkImport
Boolean
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsubTopic
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.
- sendForBulkImport
boolean
- 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_bulk_import
bool
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsubTopic
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.
- sendForBulkImport
Boolean
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
NotificationConfigResponse
Specifies where to send notifications upon changes to a data store.
- PubsubTopic
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.
- SendForBulkImport
bool
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- PubsubTopic
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.
- SendForBulkImport
bool
- 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_bulk_import
bool
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsubTopic
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.
- sendForBulkImport
Boolean
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsubTopic
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.
- sendForBulkImport
boolean
- 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_bulk_import
bool
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
- pubsubTopic
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.
- sendForBulkImport
Boolean
- Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports.
Options, OptionsArgs
Specifies additional options to apply to the base profile.
OptionsPrimaryIds
Set Action for StudyInstanceUID, SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID.
| Name | Value | Description |
|---|
| PrimaryIdsOptionUnspecified | PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
| Keep | KEEP | Keep primary IDs. |
| Regen | REGEN | Regenerate primary IDs. |
| Name | Value | Description |
|---|
| OptionsPrimaryIdsPrimaryIdsOptionUnspecified | PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
| OptionsPrimaryIdsKeep | KEEP | Keep primary IDs. |
| OptionsPrimaryIdsRegen | REGEN | Regenerate primary IDs. |
| Value | Description |
|---|
PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
KEEP | Keep primary IDs. |
REGEN | Regenerate primary IDs. |
| Name | Value | Description |
|---|
| PrimaryIdsOptionUnspecified | PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
| Keep | KEEP | Keep primary IDs. |
| Regen | REGEN | Regenerate primary IDs. |
| Name | Value | Description |
|---|
| PrimaryIdsOptionUnspecified | PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
| Keep | KEEP | Keep primary IDs. |
| Regen | REGEN | Regenerate primary IDs. |
| Name | Value | Description |
|---|
| PRIMARY_IDS_OPTION_UNSPECIFIED | PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
| KEEP | KEEP | Keep primary IDs. |
| REGEN | REGEN | Regenerate primary IDs. |
| Value | Description |
|---|
PRIMARY_IDS_OPTION_UNSPECIFIED | No value provided. Default to the behavior specified by the base profile. |
KEEP | Keep primary IDs. |
REGEN | Regenerate primary IDs. |
OptionsResponse
Specifies additional options to apply to the base profile.
SchemaConfig, SchemaConfigArgs
Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.
- LastUpdatedPartitionConfig
TimePartitioning
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- RecursiveStructureDepth
string
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - SchemaType
SchemaConfigSchemaType
- Specifies the output schema type. Schema type is required.
- lastUpdatedPartitionConfig
TimePartitioning
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursiveStructureDepth
String
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schemaType
SchemaConfigSchemaType
- Specifies the output schema type. Schema type is required.
- lastUpdatedPartitionConfig
TimePartitioning
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursiveStructureDepth
string
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schemaType
SchemaConfigSchemaType
- Specifies the output schema type. Schema type is required.
- last_updated_partition_config
TimePartitioning
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive_structure_depth
str
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema_type
SchemaConfigSchemaType
- Specifies the output schema type. Schema type is required.
SchemaConfigResponse
Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.
- LastUpdatedPartitionConfig
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.TimePartitioningResponse
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- RecursiveStructureDepth
string
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - SchemaType
string
- Specifies the output schema type. Schema type is required.
- LastUpdatedPartitionConfig
TimePartitioningResponse
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- RecursiveStructureDepth
string
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - SchemaType
string
- Specifies the output schema type. Schema type is required.
- last_updated_partition_config
object
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive_structure_depth
string
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema_type
string
- Specifies the output schema type. Schema type is required.
- lastUpdatedPartitionConfig
TimePartitioningResponse
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursiveStructureDepth
String
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schemaType
String
- Specifies the output schema type. Schema type is required.
- lastUpdatedPartitionConfig
TimePartitioningResponse
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursiveStructureDepth
string
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schemaType
string
- Specifies the output schema type. Schema type is required.
- last_updated_partition_config
TimePartitioningResponse
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursive_structure_depth
str
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schema_type
str
- Specifies the output schema type. Schema type is required.
- lastUpdatedPartitionConfig
Property Map
- The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column.
- recursiveStructureDepth
String
- The depth for all recursive structures in the output analytics schema. For example,
concept in the CodeSystem resource is a recursive structure; when the depth is 2, the CodeSystem table will have a column called concept.concept but not concept.concept.concept. If not specified or set to 0, the server will use the default value 2. The maximum depth allowed is 5. - schemaType
String
- Specifies the output schema type. Schema type is required.
SchemaConfigSchemaType
Specifies the output schema type. Schema type is required.
| Name | Value | Description |
|---|
| SchemaTypeUnspecified | SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
| Lossless | LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
| Analytics | ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
| AnalyticsV2 | ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
| Name | Value | Description |
|---|
| SchemaConfigSchemaTypeSchemaTypeUnspecified | SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
| SchemaConfigSchemaTypeLossless | LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
| SchemaConfigSchemaTypeAnalytics | ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
| SchemaConfigSchemaTypeAnalyticsV2 | ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
| Value | Description |
|---|
SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
| Name | Value | Description |
|---|
| SchemaTypeUnspecified | SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
| Lossless | LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
| Analytics | ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
| AnalyticsV2 | ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
| Name | Value | Description |
|---|
| SchemaTypeUnspecified | SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
| Lossless | LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
| Analytics | ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
| AnalyticsV2 | ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
| Name | Value | Description |
|---|
| SCHEMA_TYPE_UNSPECIFIED | SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
| LOSSLESS | LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
| ANALYTICS | ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
| ANALYTICS_V2 | ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
| Value | Description |
|---|
SCHEMA_TYPE_UNSPECIFIED | No schema type specified. This type is unsupported. |
LOSSLESS | A data-driven schema generated from the fields present in the FHIR data being exported, with no additional simplification. This type cannot be used for streaming to BigQuery. |
ANALYTICS | Analytics schema defined by the FHIR community. See https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md. BigQuery only allows a maximum of 10,000 columns per table. Due to this limitation, the server will not generate schemas for fields of type Resource, which can hold any resource type. The affected fields are Parameters.parameter.resource, Bundle.entry.resource, and Bundle.entry.response.outcome. Analytics schema does not gracefully handle extensions with one or more occurrences, anaytics schema also does not handle contained resource. |
ANALYTICS_V2 | Analytics V2, similar to schema defined by the FHIR community, with added support for extensions with one or more occurrences and contained resources in stringified JSON. Analytics V2 uses more space in the destination table than Analytics V1. It is generally recommended to use Analytics V2 over Analytics. |
SearchConfig, SearchConfigArgs
Contains the configuration for FHIR search.
SearchConfigResponse
Contains the configuration for FHIR search.
SearchParameter, SearchParameterArgs
Contains the versioned name and the URL for one SearchParameter.
- CanonicalUrl
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}/
- CanonicalUrl
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}/
- canonicalUrl
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}/
- canonicalUrl
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}/
- canonicalUrl
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}/
SearchParameterResponse
Contains the versioned name and the URL for one SearchParameter.
- CanonicalUrl
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}/
- CanonicalUrl
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}/
- canonicalUrl
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}/
- canonicalUrl
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}/
- canonicalUrl
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}/
StreamConfig, StreamConfigArgs
Contains configuration for streaming FHIR export.
- BigqueryDestination
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.GoogleCloudHealthcareV1beta1FhirBigQueryDestination
- 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).
- DeidentifiedStoreDestination
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.DeidentifiedStoreDestination
- 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).
- ResourceTypes
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.
- BigqueryDestination
GoogleCloudHealthcareV1beta1FhirBigQueryDestination
- 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).
- DeidentifiedStoreDestination
DeidentifiedStoreDestination
- 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).
- ResourceTypes
[]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
object
- 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_destination
object
- 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.
- bigqueryDestination
GoogleCloudHealthcareV1beta1FhirBigQueryDestination
- 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).
- deidentifiedStoreDestination
DeidentifiedStoreDestination
- 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).
- resourceTypes
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.
- bigqueryDestination
GoogleCloudHealthcareV1beta1FhirBigQueryDestination
- 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).
- deidentifiedStoreDestination
DeidentifiedStoreDestination
- 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).
- resourceTypes
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
GoogleCloudHealthcareV1beta1FhirBigQueryDestination
- 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_destination
DeidentifiedStoreDestination
- 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.
- bigqueryDestination
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).
- deidentifiedStoreDestination
Property Map
- 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).
- resourceTypes
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.
StreamConfigResponse
Contains configuration for streaming FHIR export.
- BigqueryDestination
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
- 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).
- DeidentifiedStoreDestination
Pulumi.GoogleNative.Healthcare.V1Beta1.Inputs.DeidentifiedStoreDestinationResponse
- 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).
- ResourceTypes
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.
- BigqueryDestination
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
- 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).
- DeidentifiedStoreDestination
DeidentifiedStoreDestinationResponse
- 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).
- ResourceTypes
[]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
object
- 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_destination
object
- 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.
- bigqueryDestination
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
- 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).
- deidentifiedStoreDestination
DeidentifiedStoreDestinationResponse
- 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).
- resourceTypes
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.
- bigqueryDestination
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
- 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).
- deidentifiedStoreDestination
DeidentifiedStoreDestinationResponse
- 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).
- resourceTypes
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
GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse
- 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_destination
DeidentifiedStoreDestinationResponse
- 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.
- bigqueryDestination
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).
- deidentifiedStoreDestination
Property Map
- 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).
- resourceTypes
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.
TagFilterList, TagFilterListArgs
List of tags to be filtered.
TagFilterListResponse
List of tags to be filtered.
TextConfig, TextConfigArgs
Configures how to transform sensitive text InfoTypes.
TextConfigProfileType
Base profile type for text transformation.
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| Empty | EMPTY | Empty profile which does not perform any transformations. |
| Basic | BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
| Name | Value | Description |
|---|
| TextConfigProfileTypeProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| TextConfigProfileTypeEmpty | EMPTY | Empty profile which does not perform any transformations. |
| TextConfigProfileTypeBasic | BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
| Value | Description |
|---|
PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
EMPTY | Empty profile which does not perform any transformations. |
BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| Empty | EMPTY | Empty profile which does not perform any transformations. |
| Basic | BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
| Name | Value | Description |
|---|
| ProfileTypeUnspecified | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| Empty | EMPTY | Empty profile which does not perform any transformations. |
| Basic | BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
| Name | Value | Description |
|---|
| PROFILE_TYPE_UNSPECIFIED | PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
| EMPTY | EMPTY | Empty profile which does not perform any transformations. |
| BASIC | BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
| Value | Description |
|---|
PROFILE_TYPE_UNSPECIFIED | No profile provided. Same as BASIC. |
EMPTY | Empty profile which does not perform any transformations. |
BASIC | Automatically converts "DATE" infoTypes using a DateShiftConfig, and all other infoTypes using a ReplaceWithInfoTypeConfig. |
TextConfigResponse
Configures how to transform sensitive text InfoTypes.
- additional_transformations
list(object)
- Additional transformations to apply to the detected data, overriding
profile. - exclude_info_types
list(string)
- InfoTypes to skip transforming, overriding
profile. - profile_type
string
- Base profile type for text transformation.
- transformations
list(object)
- The transformations to apply to the detected data. Deprecated. Use
additional_transformations instead.Deprecated: The transformations to apply to the detected data. Deprecated. Use additional_transformations instead.
TimePartitioning, TimePartitioningArgs
Configuration for FHIR BigQuery time-partitioned tables.
TimePartitioningResponse
Configuration for FHIR BigQuery time-partitioned tables.
- ExpirationMs
string
- Number of milliseconds for which to keep the storage for a partition.
- Type
string
- Type of partitioning.
- ExpirationMs
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.
- expirationMs
String
- Number of milliseconds for which to keep the storage for a partition.
- type
String
- Type of partitioning.
- expirationMs
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.
- expirationMs
String
- Number of milliseconds for which to keep the storage for a partition.
- type
String
- Type of partitioning.
TimePartitioningType
Type of partitioning.
| Name | Value | Description |
|---|
| PartitionTypeUnspecified | PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
| Hour | HOUR | Data partitioned by hour. |
| Day | DAY | Data partitioned by day. |
| Month | MONTH | Data partitioned by month. |
| Year | YEAR | Data partitioned by year. |
| Name | Value | Description |
|---|
| TimePartitioningTypePartitionTypeUnspecified | PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
| TimePartitioningTypeHour | HOUR | Data partitioned by hour. |
| TimePartitioningTypeDay | DAY | Data partitioned by day. |
| TimePartitioningTypeMonth | MONTH | Data partitioned by month. |
| TimePartitioningTypeYear | YEAR | Data partitioned by year. |
| Value | Description |
|---|
PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
HOUR | Data partitioned by hour. |
DAY | Data partitioned by day. |
MONTH | Data partitioned by month. |
YEAR | Data partitioned by year. |
| Name | Value | Description |
|---|
| PartitionTypeUnspecified | PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
| Hour | HOUR | Data partitioned by hour. |
| Day | DAY | Data partitioned by day. |
| Month | MONTH | Data partitioned by month. |
| Year | YEAR | Data partitioned by year. |
| Name | Value | Description |
|---|
| PartitionTypeUnspecified | PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
| Hour | HOUR | Data partitioned by hour. |
| Day | DAY | Data partitioned by day. |
| Month | MONTH | Data partitioned by month. |
| Year | YEAR | Data partitioned by year. |
| Name | Value | Description |
|---|
| PARTITION_TYPE_UNSPECIFIED | PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
| HOUR | HOUR | Data partitioned by hour. |
| DAY | DAY | Data partitioned by day. |
| MONTH | MONTH | Data partitioned by month. |
| YEAR | YEAR | Data partitioned by year. |
| Value | Description |
|---|
PARTITION_TYPE_UNSPECIFIED | Default unknown time. |
HOUR | Data partitioned by hour. |
DAY | Data partitioned by day. |
MONTH | Data partitioned by month. |
YEAR | Data partitioned by year. |
ValidationConfig, ValidationConfigArgs
Contains the configuration for FHIR profiles and validation.
- DisableFhirpathValidation
bool
- 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.
- DisableProfileValidation
bool
- 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.
- DisableReferenceTypeValidation
bool
- 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.
- DisableRequiredFieldValidation
bool
- 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.
- EnabledImplementationGuides
List<string>
- 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"]. If enabled_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 the global 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.
- DisableFhirpathValidation
bool
- 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.
- DisableProfileValidation
bool
- 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.
- DisableReferenceTypeValidation
bool
- 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.
- DisableRequiredFieldValidation
bool
- 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.
- EnabledImplementationGuides
[]string
- 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"]. If enabled_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 the global 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_validation
bool
- 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_validation
bool
- 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_type_validation
bool
- 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_field_validation
bool
- 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_guides
list(string)
- 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"]. If enabled_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 the global 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.
- disableFhirpathValidation
Boolean
- 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.
- disableProfileValidation
Boolean
- 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.
- disableReferenceTypeValidation
Boolean
- 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.
- disableRequiredFieldValidation
Boolean
- 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.
- enabledImplementationGuides
List<String>
- 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"]. If enabled_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 the global 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.
- disableFhirpathValidation
boolean
- 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.
- disableProfileValidation
boolean
- 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.
- disableReferenceTypeValidation
boolean
- 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.
- disableRequiredFieldValidation
boolean
- 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.
- enabledImplementationGuides
string[]
- 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"]. If enabled_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 the global 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_validation
bool
- 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_validation
bool
- 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_type_validation
bool
- 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_field_validation
bool
- 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_guides
Sequence[str]
- 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"]. If enabled_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 the global 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.
- disableFhirpathValidation
Boolean
- 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.
- disableProfileValidation
Boolean
- 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.
- disableReferenceTypeValidation
Boolean
- 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.
- disableRequiredFieldValidation
Boolean
- 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.
- enabledImplementationGuides
List<String>
- 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"]. If enabled_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 the global 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.
ValidationConfigResponse
Contains the configuration for FHIR profiles and validation.
- DisableFhirpathValidation
bool
- 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.
- DisableProfileValidation
bool
- 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.
- DisableReferenceTypeValidation
bool
- 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.
- DisableRequiredFieldValidation
bool
- 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.
- EnabledImplementationGuides
List<string>
- 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"]. If enabled_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 the global 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.
- DisableFhirpathValidation
bool
- 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.
- DisableProfileValidation
bool
- 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.
- DisableReferenceTypeValidation
bool
- 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.
- DisableRequiredFieldValidation
bool
- 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.
- EnabledImplementationGuides
[]string
- 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"]. If enabled_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 the global 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_validation
bool
- 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_validation
bool
- 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_type_validation
bool
- 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_field_validation
bool
- 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_guides
list(string)
- 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"]. If enabled_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 the global 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.
- disableFhirpathValidation
Boolean
- 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.
- disableProfileValidation
Boolean
- 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.
- disableReferenceTypeValidation
Boolean
- 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.
- disableRequiredFieldValidation
Boolean
- 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.
- enabledImplementationGuides
List<String>
- 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"]. If enabled_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 the global 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.
- disableFhirpathValidation
boolean
- 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.
- disableProfileValidation
boolean
- 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.
- disableReferenceTypeValidation
boolean
- 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.
- disableRequiredFieldValidation
boolean
- 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.
- enabledImplementationGuides
string[]
- 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"]. If enabled_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 the global 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_validation
bool
- 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_validation
bool
- 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_type_validation
bool
- 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_field_validation
bool
- 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_guides
Sequence[str]
- 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"]. If enabled_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 the global 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.
- disableFhirpathValidation
Boolean
- 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.
- disableProfileValidation
Boolean
- 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.
- disableReferenceTypeValidation
Boolean
- 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.
- disableRequiredFieldValidation
Boolean
- 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.
- enabledImplementationGuides
List<String>
- 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"]. If enabled_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 the global 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