# Functions
New creates a new Service.
NewService creates a new Service.
# Constants
Read, write and manage healthcare data.
See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
# Structs
AccessDeterminationLogConfig: Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations.
Action: Specifies a selection of tags and an `Action` to apply to each one.
ActivateConsentRequest: Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`.
AdminConsents: List of admin Consent resources to be applied.
AnalyzeEntitiesRequest: The request to analyze healthcare entities in a document.
AnalyzeEntitiesResponse: Includes recognized entity mentions and relationships between them.
Annotation: An annotation record.
AnnotationConfig: Specifies how to store annotations during de-identification operation.
AnnotationSource: AnnotationSource holds the source information of the annotation.
AnnotationStore: An Annotation store that can store annotation resources such as labels and tags for text, image and audio.
ApplyAdminConsentsErrorDetail: Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources.
ApplyAdminConsentsRequest: Request to apply the admin Consent resources for the specified FHIR store.
ApplyAdminConsentsResponse: Response when all admin Consent resources in scope were processed and all affected resources were reindexed successfully.
ApplyConsentsRequest: Request to apply the Consent resources for the specified FHIR store.
ApplyConsentsResponse: Response when all Consent resources in scope were processed and all affected resources were reindexed successfully.
ArchiveUserDataMappingRequest: Archives the specified User data mapping.
ArchiveUserDataMappingResponse: Archives the specified User data mapping.
Attribute: An attribute value for a Consent or User data mapping.
AttributeDefinition: A client-defined consent attribute.
AuditConfig: Specifies the audit configuration for a service.
AuditLogConfig: Provides the configuration for logging a type of permissions.
BatchGetMessagesResponse: Gets multiple messages in a specified HL7v2 store.
Binding: Associates `members`, or principals, with a `role`.
BlobStorageInfo: BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource.
BlobStorageSettings: Settings for data stored in Blob storage.
BoundingPoly: A bounding polygon for the detected image annotation.
BulkExportGcsDestination: The configuration for exporting to Cloud Storage using the bulk export API.
CancelOperationRequest: The request message for Operations.CancelOperation.
CharacterMaskConfig: Mask a string by replacing its characters with a fixed character.
CharacterMaskField: Replace field value with masking character.
CheckDataAccessRequest: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.
CheckDataAccessResponse: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.
CleanDescriptorsOption: This option is based on the DICOM Standard's Clean Descriptors Option (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/sect_E.3.5.html), and the `CleanText` `Action` is applied to all the specified fields.
CleanTextField: Inspect text and transform sensitive text.
CleanTextTag: Inspect text and transform sensitive text.
CloudHealthcareSource: Cloud Healthcare API resource.
ConfigureSearchRequest: Request to configure the search parameters for the specified FHIR store.
Consent: Represents a user's consent.
ConsentAccessorScope: The accessor scope that describes who can access, for what purpose, in which environment.
ConsentArtifact: Documentation of a user's consent.
ConsentConfig: Configures whether to enforce consent for the FHIR store and which consent enforcement version is being used.
ConsentErrors: The Consent resource name and error.
ConsentEvaluation: The detailed evaluation of a particular Consent.
ConsentHeaderHandling: How the server handles the consent header.
ConsentList: List of resource names of Consent resources.
ConsentStore: Represents a consent store.
ContextualDeidConfig: Fields that don't match a KeepField or CleanTextField `action` in the BASIC profile are collected into a contextual phrase list.
CreateMessageRequest: Creates a new message.
CryptoHashConfig: Pseudonymization method that generates surrogates via cryptographic hashing.
CryptoHashField: Replace field value with a hash of that value.
Dataset: A message representing a health dataset.
DateShiftConfig: Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.
DateShiftField: Shift the date by a randomized number of days.
DeidentifiedStoreDestination: Contains configuration for streaming de-identified FHIR export.
DeidentifyConfig: Configures de-id options specific to different types of content.
DeidentifyDatasetRequest: Redacts identifying information from the specified dataset.
DeidentifyDicomStoreRequest: Creates a new DICOM store with sensitive information de-identified.
DeidentifyFhirStoreRequest: Creates a new FHIR store with sensitive information de-identified.
DeidentifyOperationMetadata: Details about the work the de-identify operation performed.
DeidentifySummary: Contains a detailed summary of the Deidentify operation.
DeleteTag: Delete tag.
Detail: Contains multiple sensitive information findings for each resource slice.
DicomConfig: Specifies the parameters needed for de-identification of DICOM stores.
DicomFilterConfig: Specifies the filter configuration for DICOM resources.
DicomStore: Represents a DICOM store.
DicomStoreMetrics: DicomStoreMetrics contains metrics describing a DICOM store.
DicomTagConfig: Specifies the parameters needed for the de-identification of DICOM stores.
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
EncryptionSpec: Represents a customer-managed encryption key spec that can be applied to a resource.
Entity: The candidate entities that an entity mention could link to.
EntityMention: An entity mention in the document.
EntityMentionRelationship: Defines directed relationship from one entity mention to another.
EvaluateAnnotationStoreRequest: Request to evaluate an Annotation store against a ground truth [Annotation store].
EvaluateAnnotationStoreResponse: Response for successful Annotation store evaluation operations.
EvaluateUserConsentsRequest: Evaluate a user's Consents for all matching User data mappings.
ExplainDataAccessConsentInfo: The enforcing consent's metadata.
ExplainDataAccessConsentScope: A single consent scope that provides info on who has access to the requested resource scope for a particular purpose and environment, enforced by which consent.
ExplainDataAccessResponse: List of consent scopes that are applicable to the explained access on a given resource.
ExportAnnotationsRequest: Request to export Annotations.
ExportAnnotationsResponse: Response for successful annotation export operations.
ExportDicomDataRequest: Exports data from the specified DICOM store.
ExportDicomDataResponse: Returns additional information in regards to a completed DICOM store export.
ExportMessagesRequest: Request to schedule an export.
ExportMessagesResponse: Final response for the export operation.
ExportResourcesHistoryRequest: Request to export the history of resources.
ExportResourcesRequest: Request to export resources.
Expr: Represents a textual expression in the Common Expression Language (CEL) syntax.
Feature: A feature of an entity mention.
FhirConfig: Specifies how to handle de-identification of a FHIR store.
FhirFieldConfig: Specifies how to handle the de-identification of a FHIR store.
FhirFilter: Filter configuration.
FhirNotificationConfig: Contains the configuration for FHIR notifications.
FhirOutput: Details about the FHIR store to write the output to.
FhirStore: Represents a FHIR store.
FhirStoreMetric: Count of resources and total storage size by type for a given FHIR store.
FhirStoreMetrics: List of metrics for a given FHIR store.
Field: A (sub) field of a type.
FieldMetadata: Specifies FHIR paths to match, and how to handle de-identification of matching fields.
FilterList: List of infoTypes to be filtered.
GcsDestination: The Cloud Storage output destination.
GcsSource: Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination: The BigQuery table for export.
GoogleCloudHealthcareV1beta1AnnotationGcsDestination: The Cloud Storage location for export.
GoogleCloudHealthcareV1beta1AnnotationGcsSource: Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1beta1ConsentGcsDestination: The Cloud Storage location for export.
GoogleCloudHealthcareV1beta1ConsentPolicy: Represents a user's consent in terms of the resources that can be accessed and under what conditions.
GoogleCloudHealthcareV1beta1DeidentifyDeidentifyDicomStoreSummary: Contains a summary of the DeidentifyDicomStore operation.
GoogleCloudHealthcareV1beta1DeidentifyDeidentifyFhirStoreSummary: Contains a summary of the DeidentifyFhirStore operation.
GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata: Specifies the FHIR paths to match and how to handle the de-identification of matching fields.
GoogleCloudHealthcareV1beta1DeidentifyOptions: Specifies additional options to apply to the base ProfileType.
GoogleCloudHealthcareV1beta1DicomBigQueryDestination: The BigQuery table where the server writes output.
GoogleCloudHealthcareV1beta1DicomGcsDestination: The Cloud Storage location where the server writes the output and the export configuration.
GoogleCloudHealthcareV1beta1DicomGcsSource: Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1beta1DicomStreamConfig: StreamConfig specifies configuration for a streaming DICOM export.
GoogleCloudHealthcareV1beta1FhirBigQueryDestination: The configuration for exporting to BigQuery.
GoogleCloudHealthcareV1beta1FhirChangeDataCaptureConfig: BigQuery Change Data Capture configuration.
GoogleCloudHealthcareV1beta1FhirExportResourcesResponse: Response when all resources export successfully.
GoogleCloudHealthcareV1beta1FhirGcsDestination: The configuration for exporting to Cloud Storage.
GoogleCloudHealthcareV1beta1FhirGcsSource: Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1beta1FhirImportResourcesResponse: Final response of importing resources.
GroupOrSegment: Construct representing a logical group or a segment.
Hl7SchemaConfig: Root config message for HL7v2 schema.
Hl7TypesConfig: Root config for HL7v2 datatype definitions for a specific HL7v2 version.
Hl7V2NotificationConfig: Specifies where and whether to send notifications upon changes to a data store.
Hl7V2Store: Represents an HL7v2 store.
Hl7V2StoreMetric: Count of messages and total storage size by type for a given HL7 store.
Hl7V2StoreMetrics: List of metrics for a given HL7v2 store.
HttpBody: Message that represents an arbitrary HTTP body.
Image: Raw bytes representing consent artifact content.
ImageAnnotation: Image annotation.
ImageConfig: Specifies how to handle de-identification of image pixels.
ImportAnnotationsRequest: Request to import Annotations.
ImportAnnotationsResponse: Final response of importing Annotations in successful case.
ImportDicomDataRequest: Imports data into the specified DICOM store.
ImportDicomDataResponse: Returns additional information in regards to a completed DICOM store import.
ImportMessagesRequest: Request to import messages.
ImportMessagesResponse: Final response of importing messages.
ImportResourcesHistoryRequest: Request to import the history of resources.
ImportResourcesRequest: Request to import resources.
InfoTypeConfig: Specifies how to use infoTypes for evaluation.
InfoTypeTransformation: A transformation to apply to text that is identified as a specific info_type.
IngestMessageRequest: Ingests a message into the specified HL7v2 store.
IngestMessageResponse: Acknowledges that a message has been ingested into the specified HL7v2 store.
KeepExtensionsConfig: The behavior for handling FHIR extensions that aren't otherwise specified for de-identification.
KeepField: Keep field unchanged.
KeepTag: Keep tag unchanged.
KmsWrappedCryptoKey: Include to use an existing data crypto key wrapped by KMS.
LinkedEntity: EntityMentions can be linked to multiple entities using a LinkedEntity message lets us add other fields, e.g.
ListAnnotationsResponse: Lists the Annotations in the specified Annotation store.
ListAnnotationStoresResponse: Lists the Annotation stores in the given dataset.
ListDatasetsResponse: Lists the available datasets.
ListDicomStoresResponse: Lists the DICOM stores in the given dataset.
ListFhirStoresResponse: Lists the FHIR stores in the given dataset.
ListHl7V2StoresResponse: Lists the HL7v2 stores in the given dataset.
ListLocationsResponse: The response message for Locations.ListLocations.
ListMessagesResponse: Lists the messages in the specified HL7v2 store.
ListOperationsResponse: The response message for Operations.ListOperations.
Location: A resource that represents a Google Cloud location.
Message: A complete HL7v2 message.
NotificationConfig: Specifies where to send notifications upon changes to a data store.
Operation: This resource represents a long-running operation that is the result of a network API call.
OperationMetadata: OperationMetadata provides information about the operation execution.
Options: Specifies additional options to apply to the base profile.
ParsedData: The content of an HL7v2 message in a structured format.
ParserConfig: The configuration for the parser.
PatientId: A patient identifier and associated type.
PatientScope: Apply consents given by a list of patients.
Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
ProgressCounter: ProgressCounter provides counters to describe an operation's progress.
PubsubDestination: The Pub/Sub output destination.
QueryAccessibleDataRequest: Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination.
QueryAccessibleDataResponse: Response for successful QueryAccessibleData operations.
RecurseTag: Recursively apply DICOM de-id to tags nested in a sequence.
RedactConfig: Define how to redact sensitive values.
RegenUidTag: Replace UID with a new generated UID.
RejectConsentRequest: Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`.
RemoveField: Remove field.
RemoveTag: Replace with empty tag.
ReplaceWithInfoTypeConfig: When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type.
ResetTag: Reset tag to a placeholder value.
ResourceAnnotation: Resource level annotation.
Resources: A list of FHIR resources.
Result: The consent evaluation result for a single `data_id`.
RevokeConsentRequest: Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`.
RollbackFhirResourceFilteringFields: Filters to select resources that need to be rolled back.
RollbackFhirResourcesRequest: Request to roll back resources.
RollbackFhirResourcesResponse: Final response of rollback FHIR resources request.
RollbackHL7MessagesFilteringFields: Filtering fields for an HL7v2 rollback.
RollbackHl7V2MessagesRequest: Point in time recovery rollback request.
RollbackHl7V2MessagesResponse: Final response of rollback FHIR resources request.
SchemaConfig: Configuration for the FHIR BigQuery schema.
SchemaGroup: An HL7v2 logical group construct.
SchemaPackage: A schema package contains a set of schemas and type definitions.
SchemaSegment: An HL7v2 Segment.
SchematizedData: The content of an HL7v2 message in a structured format as specified by a schema.
SearchConfig: Contains the configuration for FHIR search.
SearchParameter: Contains the versioned name and the URL for one SearchParameter.
SearchResourcesRequest: Request to search the resources in the specified FHIR store.
Segment: A segment in a structured format.
SensitiveTextAnnotation: A TextAnnotation specifies a text range that includes sensitive information.
SeriesMetrics: SeriesMetrics contains metrics describing a DICOM series.
SetBlobStorageSettingsRequest: Request message for `SetBlobStorageSettings` method.
SetBlobStorageSettingsResponse: Returns additional info in regards to a completed set blob storage settings API.
SetIamPolicyRequest: Request message for `SetIamPolicy` method.
Signature: User signature.
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
StorageInfo: StorageInfo encapsulates all the storage info of a resource.
StreamConfig: Contains configuration for streaming FHIR export.
StructuredStorageInfo: StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.
StudyMetrics: StudyMetrics contains metrics describing a DICOM study.
TagFilterList: List of tags to be filtered.
TestIamPermissionsRequest: Request message for `TestIamPermissions` method.
TestIamPermissionsResponse: Response message for `TestIamPermissions` method.
TextConfig: Configures how to transform sensitive text `InfoTypes`.
TextSpan: A span of text in the provided document.
TimePartitioning: Configuration for FHIR BigQuery time-partitioned tables.
TimeRange: Apply consents given by patients whose most recent consent changes are in the time range.
Type: A type definition for some HL7v2 type (incl.
UserDataMapping: Maps a resource to the associated user and Attributes.
ValidationConfig: Contains the configuration for FHIR profiles and validation.
VersionSource: Describes a selector for extracting and matching an MSH field to a value.
Vertex: A 2D coordinate in an image.