pulumi-google-native-kotlin/com.pulumi.googlenative.healthcare.v1beta1.kotlin.outputs

Package-level declarations

Types

data class ActionResponse(val cleanImageTag: ImageConfigResponse, val cleanTextTag: CleanTextTagResponse, val deleteTag: DeleteTagResponse, val keepTag: KeepTagResponse, val queries: List<String>, val recurseTag: RecurseTagResponse, val regenUidTag: RegenUidTagResponse, val removeTag: RemoveTagResponse, val resetTag: ResetTagResponse)

Specifies a selection of tags and an Action to apply to each one.

AnnotationConfigResponse

data class AnnotationConfigResponse(val annotationStoreName: String, val storeQuote: Boolean)

Specifies how to store annotations during de-identification operation.

AnnotationSourceResponse

data class AnnotationSourceResponse(val cloudHealthcareSource: CloudHealthcareSourceResponse)

AnnotationSource holds the source information of the annotation.

AttributeResponse

data class AttributeResponse(val attributeDefinitionId: String, val values: List<String>)

An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.

AuditConfigResponse

data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

AuditLogConfigResponse

data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

BindingResponse

data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

BoundingPolyResponse

data class BoundingPolyResponse(val label: String, val vertices: List<VertexResponse>)

A bounding polygon for the detected image annotation.

CharacterMaskConfigResponse

data class CharacterMaskConfigResponse(val maskingCharacter: String)

Mask a string by replacing its characters with a fixed character.

CharacterMaskFieldResponse

class CharacterMaskFieldResponse

Replace field value with masking character. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml

CleanDescriptorsOptionResponse

class CleanDescriptorsOptionResponse

This option is based on the DICOM Standard's Clean Descriptors Option, and the CleanText Action is applied to all the specified fields. 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. These contextual phrases are replaced with the token "CTX". This option uses an additional InfoType during inspection.

CleanTextFieldResponse

class CleanTextFieldResponse

Inspect text and transform sensitive text. Configure using TextConfig. Supported types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml

CleanTextTagResponse

class CleanTextTagResponse

Inspect text and transform sensitive text. Configurable using TextConfig. Supported 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

CloudHealthcareSourceResponse

data class CloudHealthcareSourceResponse(val name: String)

Cloud Healthcare API resource.

ContextualDeidConfigResponse

class ContextualDeidConfigResponse

The fields that aren't marked Keep or CleanText in the BASIC profile are collected into a contextual phrase list. For fields marked CleanText, the process attempts to transform phrases matching these contextual entries. These contextual phrases are replaced with the token "CTX". This feature uses an additional InfoType during inspection.

CryptoHashConfigResponse

data class CryptoHashConfigResponse(val cryptoKey: String, val kmsWrapped: KmsWrappedCryptoKeyResponse)

Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=.

CryptoHashFieldResponse

class CryptoHashFieldResponse

Replace field value with a hash of that value. Supported types: Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml

DateShiftConfigResponse

data class DateShiftConfigResponse(val cryptoKey: String, val kmsWrapped: KmsWrappedCryptoKeyResponse)

Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.

DateShiftFieldResponse

class DateShiftFieldResponse

Shift the date by a randomized number of days. See date shifting for more information. Supported types: Date, DateTime

DeidentifiedStoreDestinationResponse

data class DeidentifiedStoreDestinationResponse(val config: DeidentifyConfigResponse, val store: String)

Contains configuration for streaming de-identified FHIR export.

DeidentifyConfigResponse

data class DeidentifyConfigResponse(val annotation: AnnotationConfigResponse, val dicom: DicomConfigResponse, val dicomTagConfig: DicomTagConfigResponse, val fhir: FhirConfigResponse, val fhirFieldConfig: FhirFieldConfigResponse, val image: ImageConfigResponse, val operationMetadata: DeidentifyOperationMetadataResponse, val text: TextConfigResponse, val useRegionalDataProcessing: Boolean)

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.

DeidentifyOperationMetadataResponse

data class DeidentifyOperationMetadataResponse(val fhirOutput: FhirOutputResponse)

Details about the work the de-identify operation performed.

DeleteTagResponse

class DeleteTagResponse

Delete tag.

DicomConfigResponse

data class DicomConfigResponse(val filterProfile: String, val keepList: TagFilterListResponse, val removeList: TagFilterListResponse, val skipIdRedaction: Boolean)

Specifies the parameters needed for de-identification of DICOM stores.

DicomTagConfigResponse

data class DicomTagConfigResponse(val actions: List<ActionResponse>, val options: OptionsResponse, val profileType: String)

Specifies the parameters needed for the de-identification of DICOM stores.

ExprResponse

data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

FhirConfigResponse

data class FhirConfigResponse(val defaultKeepExtensions: Boolean, val fieldMetadataList: List<FieldMetadataResponse>)

Specifies how to handle de-identification of a FHIR store.

FhirFieldConfigResponse

data class FhirFieldConfigResponse(val fieldMetadataList: List<GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataResponse>, val options: GoogleCloudHealthcareV1beta1DeidentifyOptionsResponse, val profileType: String)

Specifies how to handle the de-identification of a FHIR store.

FhirNotificationConfigResponse

data class FhirNotificationConfigResponse(val pubsubTopic: String, val sendFullResource: Boolean, val sendPreviousResourceOnDelete: Boolean)

Contains the configuration for FHIR notifications.

FhirOutputResponse

data class FhirOutputResponse(val fhirStore: String)

Details about the FHIR store to write the output to.

FieldMetadataResponse

data class FieldMetadataResponse(val action: String, val paths: List<String>)

Specifies FHIR paths to match, and how to handle de-identification of matching fields.

FieldResponse

data class FieldResponse(val maxOccurs: Int, val minOccurs: Int, val name: String, val table: String, val type: String)

A (sub) field of a type.

GetAnnotationResult

data class GetAnnotationResult(val annotationSource: AnnotationSourceResponse, val customData: Map<String, String>, val imageAnnotation: ImageAnnotationResponse, val name: String, val resourceAnnotation: ResourceAnnotationResponse, val textAnnotation: SensitiveTextAnnotationResponse)

GetAnnotationStoreResult

data class GetAnnotationStoreResult(val labels: Map<String, String>, val name: String)

GetAttributeDefinitionResult

data class GetAttributeDefinitionResult(val allowedValues: List<String>, val category: String, val consentDefaultValues: List<String>, val dataMappingDefaultValue: String, val description: String, val name: String)

GetConsentArtifactResult

data class GetConsentArtifactResult(val consentContentScreenshots: List<ImageResponse>, val consentContentVersion: String, val guardianSignature: SignatureResponse, val metadata: Map<String, String>, val name: String, val userId: String, val userSignature: SignatureResponse, val witnessSignature: SignatureResponse)

GetConsentResult

data class GetConsentResult(val consentArtifact: String, val expireTime: String, val metadata: Map<String, String>, val name: String, val policies: List<GoogleCloudHealthcareV1beta1ConsentPolicyResponse>, val revisionCreateTime: String, val revisionId: String, val state: String, val ttl: String, val userId: String)

GetConsentStoreResult

data class GetConsentStoreResult(val defaultConsentTtl: String, val enableConsentCreateOnUpdate: Boolean, val labels: Map<String, String>, val name: String)

GetDatasetAnnotationStoreIamPolicyResult

data class GetDatasetAnnotationStoreIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetDatasetConsentStoreIamPolicyResult

data class GetDatasetConsentStoreIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetDatasetDicomStoreIamPolicyResult

data class GetDatasetDicomStoreIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetDatasetFhirStoreIamPolicyResult

data class GetDatasetFhirStoreIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetDatasetHl7V2StoreIamPolicyResult

data class GetDatasetHl7V2StoreIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetDatasetIamPolicyResult

data class GetDatasetIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)

GetDatasetResult

data class GetDatasetResult(val name: String, val timeZone: String)

GetDicomStoreResult

data class GetDicomStoreResult(val labels: Map<String, String>, val name: String, val notificationConfig: NotificationConfigResponse, val streamConfigs: List<GoogleCloudHealthcareV1beta1DicomStreamConfigResponse>)

GetFhirResult

data class GetFhirResult(val contentType: String, val data: String, val extensions: List<Map<String, String>>)

GetFhirStoreResult

data class GetFhirStoreResult(val complexDataTypeReferenceParsing: String, val defaultSearchHandlingStrict: Boolean, val disableReferentialIntegrity: Boolean, val disableResourceVersioning: Boolean, val enableUpdateCreate: Boolean, val labels: Map<String, String>, val name: String, val notificationConfig: NotificationConfigResponse, val notificationConfigs: List<FhirNotificationConfigResponse>, val searchConfig: SearchConfigResponse, val streamConfigs: List<StreamConfigResponse>, val validationConfig: ValidationConfigResponse, val version: String)

GetHl7V2StoreResult

data class GetHl7V2StoreResult(val labels: Map<String, String>, val name: String, val notificationConfig: NotificationConfigResponse, val notificationConfigs: List<Hl7V2NotificationConfigResponse>, val parserConfig: ParserConfigResponse, val rejectDuplicateMessage: Boolean)

GetMessageResult

data class GetMessageResult(val createTime: String, val data: String, val labels: Map<String, String>, val messageType: String, val name: String, val parsedData: ParsedDataResponse, val patientIds: List<PatientIdResponse>, val schematizedData: SchematizedDataResponse, val sendFacility: String, val sendTime: String)

GetUserDataMappingResult

data class GetUserDataMappingResult(val archiveTime: String, val archived: Boolean, val dataId: String, val name: String, val resourceAttributes: List<AttributeResponse>, val userId: String)

GoogleCloudHealthcareV1beta1ConsentPolicyResponse

data class GoogleCloudHealthcareV1beta1ConsentPolicyResponse(val authorizationRule: ExprResponse, val resourceAttributes: List<AttributeResponse>)

Represents a user's consent in terms of the resources that can be accessed and under what conditions.

GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataResponse

data class GoogleCloudHealthcareV1beta1DeidentifyFieldMetadataResponse(val characterMaskField: CharacterMaskFieldResponse, val cleanTextField: CleanTextFieldResponse, val cryptoHashField: CryptoHashFieldResponse, val dateShiftField: DateShiftFieldResponse, val keepField: KeepFieldResponse, val paths: List<String>, val removeField: RemoveFieldResponse)

Specifies the FHIR paths to match and how to handle the de-identification of matching fields.

GoogleCloudHealthcareV1beta1DeidentifyOptionsResponse

data class GoogleCloudHealthcareV1beta1DeidentifyOptionsResponse(val characterMaskConfig: CharacterMaskConfigResponse, val contextualDeid: ContextualDeidConfigResponse, val cryptoHashConfig: CryptoHashConfigResponse, val dateShiftConfig: DateShiftConfigResponse, val keepExtensions: KeepExtensionsConfigResponse)

Specifies additional options to apply to the base profile.

GoogleCloudHealthcareV1beta1DicomBigQueryDestinationResponse

data class GoogleCloudHealthcareV1beta1DicomBigQueryDestinationResponse(val force: Boolean, val tableUri: String, val writeDisposition: String)

The BigQuery table where the server writes output.

GoogleCloudHealthcareV1beta1DicomStreamConfigResponse

data class GoogleCloudHealthcareV1beta1DicomStreamConfigResponse(val bigqueryDestination: GoogleCloudHealthcareV1beta1DicomBigQueryDestinationResponse)

StreamConfig specifies configuration for a streaming DICOM export.

GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse

data class GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse(val datasetUri: String, val force: Boolean, val schemaConfig: SchemaConfigResponse, val writeDisposition: String)

The configuration for exporting to BigQuery.

Hl7SchemaConfigResponse

data class Hl7SchemaConfigResponse(val messageSchemaConfigs: Map<String, String>, val version: List<VersionSourceResponse>)

Root config message for HL7v2 schema. This contains a schema structure of groups and segments, and filters that determine which messages to apply the schema structure to.

Hl7TypesConfigResponse

data class Hl7TypesConfigResponse(val type: List<TypeResponse>, val version: List<VersionSourceResponse>)

Root config for HL7v2 datatype definitions for a specific HL7v2 version.

Hl7V2NotificationConfigResponse

data class Hl7V2NotificationConfigResponse(val filter: String, val pubsubTopic: String)

Specifies where and whether to send notifications upon changes to a data store.

ImageAnnotationResponse

data class ImageAnnotationResponse(val boundingPolys: List<BoundingPolyResponse>, val frameIndex: Int)

Image annotation.

ImageConfigResponse

data class ImageConfigResponse(val additionalInfoTypes: List<String>, val excludeInfoTypes: List<String>, val textRedactionMode: String)

Specifies how to handle de-identification of image pixels.

ImageResponse

data class ImageResponse(val gcsUri: String, val rawBytes: String)

Raw bytes representing consent artifact content.

InfoTypeTransformationResponse

data class InfoTypeTransformationResponse(val characterMaskConfig: CharacterMaskConfigResponse, val cryptoHashConfig: CryptoHashConfigResponse, val dateShiftConfig: DateShiftConfigResponse, val infoTypes: List<String>, val redactConfig: RedactConfigResponse, val replaceWithInfoTypeConfig: ReplaceWithInfoTypeConfigResponse)

A transformation to apply to text that is identified as a specific info_type.

KeepExtensionsConfigResponse

class KeepExtensionsConfigResponse

The behaviour for handling FHIR extensions that aren't otherwise specified for de-identification. If provided, all extensions are preserved during de-identification by default. If unspecified, all extensions are removed during de-identification by default.

KeepFieldResponse

class KeepFieldResponse

Keep field unchanged.

KeepTagResponse

class KeepTagResponse

Keep tag unchanged.

KmsWrappedCryptoKeyResponse

data class KmsWrappedCryptoKeyResponse(val cryptoKey: String, val wrappedKey: String)

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).

NotificationConfigResponse

data class NotificationConfigResponse(val pubsubTopic: String, val sendForBulkImport: Boolean)

Specifies where to send notifications upon changes to a data store.

OptionsResponse

data class OptionsResponse(val cleanDescriptors: CleanDescriptorsOptionResponse, val cleanImage: ImageConfigResponse, val primaryIds: String)

Specifies additional options to apply to the base profile.

ParsedDataResponse

data class ParsedDataResponse(val segments: List<SegmentResponse>)

The content of an HL7v2 message in a structured format.

ParserConfigResponse

data class ParserConfigResponse(val allowNullHeader: Boolean, val schema: SchemaPackageResponse, val segmentTerminator: String, val version: String)

The configuration for the parser. It determines how the server parses the messages.

PatientIdResponse

data class PatientIdResponse(val type: String, val value: String)

A patient identifier and associated type.

RecurseTagResponse

class 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

RedactConfigResponse

class RedactConfigResponse

Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jane." becomes "My name is ."

RegenUidTagResponse

class 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

RemoveFieldResponse

class RemoveFieldResponse

Remove field.

RemoveTagResponse

class RemoveTagResponse

Replace with empty tag.

ReplaceWithInfoTypeConfigResponse

class ReplaceWithInfoTypeConfigResponse

When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jane" becomes "My name is PERSON_NAME." The TRANSFORM action is equivalent to redacting.

ResetTagResponse

class ResetTagResponse

Reset tag to a placeholder value.

ResourceAnnotationResponse

data class ResourceAnnotationResponse(val label: String)

Resource level annotation.

SchemaConfigResponse

data class SchemaConfigResponse(val lastUpdatedPartitionConfig: TimePartitioningResponse, val recursiveStructureDepth: String, val schemaType: String)

Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.

SchemaPackageResponse

data class SchemaPackageResponse(val ignoreMinOccurs: Boolean, val schemas: List<Hl7SchemaConfigResponse>, val schematizedParsingType: String, val types: List<Hl7TypesConfigResponse>, val unexpectedSegmentHandling: String)

A schema package contains a set of schemas and type definitions.

SchematizedDataResponse

data class SchematizedDataResponse(val data: String, val error: String)

The content of an HL7v2 message in a structured format as specified by a schema.

SearchConfigResponse

data class SearchConfigResponse(val searchParameters: List<SearchParameterResponse>)

Contains the configuration for FHIR search.

SearchParameterResponse

data class SearchParameterResponse(val canonicalUrl: String, val parameter: String)

Contains the versioned name and the URL for one SearchParameter.

SegmentResponse

data class SegmentResponse(val fields: Map<String, String>, val segmentId: String, val setId: String)

A segment in a structured format.

SensitiveTextAnnotationResponse

data class SensitiveTextAnnotationResponse(val details: Map<String, String>)

A TextAnnotation specifies a text range that includes sensitive information.

SignatureResponse

data class SignatureResponse(val image: ImageResponse, val metadata: Map<String, String>, val signatureTime: String, val userId: String)

User signature.

StreamConfigResponse

data class StreamConfigResponse(val bigqueryDestination: GoogleCloudHealthcareV1beta1FhirBigQueryDestinationResponse, val deidentifiedStoreDestination: DeidentifiedStoreDestinationResponse, val resourceTypes: List<String>)

Contains configuration for streaming FHIR export.

TagFilterListResponse

data class TagFilterListResponse(val tags: List<String>)

List of tags to be filtered.

TextConfigResponse

data class TextConfigResponse(val additionalTransformations: List<InfoTypeTransformationResponse>, val excludeInfoTypes: List<String>, val profileType: String, val transformations: List<InfoTypeTransformationResponse>)

Configures how to transform sensitive text InfoTypes.

TimePartitioningResponse

data class TimePartitioningResponse(val expirationMs: String, val type: String)

Configuration for FHIR BigQuery time-partitioned tables.

TypeResponse

data class TypeResponse(val fields: List<FieldResponse>, val name: String, val primitive: String)

A type definition for some HL7v2 type (incl. Segments and Datatypes).

ValidationConfigResponse

data class ValidationConfigResponse(val disableFhirpathValidation: Boolean, val disableProfileValidation: Boolean, val disableReferenceTypeValidation: Boolean, val disableRequiredFieldValidation: Boolean, val enabledImplementationGuides: List<String>)

Contains the configuration for FHIR profiles and validation.

VersionSourceResponse

data class VersionSourceResponse(val mshField: String, val value: String)

Describes a selector for extracting and matching an MSH field to a value.

VertexResponse

data class VertexResponse(val x: Double, val y: Double)

A 2D coordinate in an image. The origin is the top-left.