healthcare.v1 library Null safety

Cloud Healthcare API - v1

Manage, store, and access healthcare data in Google Cloud Platform.

For more information, see cloud.google.com/healthcare

Create an instance of CloudHealthcareApi to access these resources:

Classes

ActivateConsentRequest
Activates the latest revision of the specified Consent by committing a new revision with state updated to ACTIVE. [...]
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. [...]
Binding
Associates members with a role.
CancelOperationRequest
The request message for Operations.CancelOperation.
CharacterMaskConfig
Mask a string by replacing its characters with a fixed 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.
CloudHealthcareApi
Manage, store, and access healthcare data in Google Cloud Platform.
Represents a user's consent.
ConsentArtifact
Documentation of a user's consent.
ConsentEvaluation
The detailed evaluation of a particular Consent.
ConsentList
List of resource names of Consent resources.
ConsentStore
Represents a consent store.
CreateMessageRequest
Creates a new message.
CryptoHashConfig
Pseudonymization method that generates surrogates via cryptographic hashing. [...]
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.
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.
DeidentifySummary
Contains a summary of the Deidentify operation.
DicomConfig
Specifies the parameters needed for de-identification of DICOM stores.
DicomFilterConfig
Specifies the filter configuration for DICOM resources.
DicomStore
Represents a DICOM store.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
EvaluateUserConsentsRequest
Evaluate a user's Consents for all matching User data mappings. [...]
EvaluateUserConsentsResponse
ExportDicomDataRequest
Exports data from the specified DICOM store. [...]
ExportDicomDataResponse
Returns additional information in regards to a completed DICOM store export.
ExportResourcesRequest
Request to export resources.
ExportResourcesResponse
Response when all resources export successfully. [...]
Expr
Represents a textual expression in the Common Expression Language (CEL) syntax. [...]
FhirConfig
Specifies how to handle de-identification of a FHIR store.
FhirFilter
Filter configuration.
FhirStore
Represents a FHIR store.
Field
A (sub) field of a type.
FieldMetadata
Specifies FHIR paths to match, and how to handle de-identification of matching fields.
GoogleCloudHealthcareV1ConsentGcsDestination
The Cloud Storage location for export.
GoogleCloudHealthcareV1ConsentPolicy
Represents a user's consent in terms of the resources that can be accessed and under what conditions.
GoogleCloudHealthcareV1DeidentifyDeidentifyDicomStoreSummary
Contains a summary of the DeidentifyDicomStore operation.
GoogleCloudHealthcareV1DeidentifyDeidentifyFhirStoreSummary
Contains a summary of the DeidentifyFhirStore operation.
GoogleCloudHealthcareV1DicomBigQueryDestination
The BigQuery table where the server writes the output.
GoogleCloudHealthcareV1DicomGcsDestination
The Cloud Storage location where the server writes the output and the export configuration.
GoogleCloudHealthcareV1DicomGcsSource
Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1FhirBigQueryDestination
The configuration for exporting to BigQuery.
GoogleCloudHealthcareV1FhirGcsDestination
The configuration for exporting to Cloud Storage.
GoogleCloudHealthcareV1FhirGcsSource
Specifies the configuration for importing data from Cloud Storage.
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.
HttpBody
Message that represents an arbitrary HTTP body. [...]
Image
Raw bytes representing consent artifact content.
ImageConfig
Specifies how to handle de-identification of image pixels.
ImportDicomDataRequest
Imports data into the specified DICOM store. [...]
ImportDicomDataResponse
Returns additional information in regards to a completed DICOM store import.
ImportResourcesRequest
Request to import resources.
ImportResourcesResponse
Final response of importing resources. [...]
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.
ListAttributeDefinitionsResponse
ListConsentArtifactsResponse
ListConsentRevisionsResponse
ListConsentsResponse
ListConsentStoresResponse
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.
ListUserDataMappingsResponse
Location
A resource that represents Google Cloud Platform 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. [...]
ParsedData
The content of a HL7v2 message in a structured format.
ParserConfig
The configuration for the parser. [...]
PatientId
A patient identifier and associated type.
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.
ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsResource
ProjectsLocationsDatasetsConsentStoresConsentArtifactsResource
ProjectsLocationsDatasetsConsentStoresConsentsResource
ProjectsLocationsDatasetsConsentStoresResource
ProjectsLocationsDatasetsConsentStoresUserDataMappingsResource
ProjectsLocationsDatasetsDicomStoresResource
ProjectsLocationsDatasetsDicomStoresStudiesResource
ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesResource
ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesResource
ProjectsLocationsDatasetsDicomStoresStudiesSeriesResource
ProjectsLocationsDatasetsFhirStoresFhirResource
ProjectsLocationsDatasetsFhirStoresResource
ProjectsLocationsDatasetsHl7V2StoresMessagesResource
ProjectsLocationsDatasetsHl7V2StoresResource
ProjectsLocationsDatasetsOperationsResource
ProjectsLocationsDatasetsResource
ProjectsLocationsResource
ProjectsResource
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. [...]
RedactConfig
Define how to redact sensitive values. [...]
RejectConsentRequest
Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. [...]
ReplaceWithInfoTypeConfig
When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. [...]
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. [...]
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.
SearchResourcesRequest
Request to search the resources in the specified FHIR store.
Segment
A segment in a structured format.
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. [...]
StreamConfig
Contains configuration for streaming FHIR export.
TagFilterList
List of tags to be filtered.
TestIamPermissionsRequest
Request message for TestIamPermissions method.
TestIamPermissionsResponse
Response message for TestIamPermissions method.
TextConfig
Type
A type definition for some HL7v2 type (incl. [...]
UserDataMapping
Maps a resource to the associated user and Attributes.
VersionSource
Describes a selector for extracting and matching an MSH field to a value.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.