healthcare/v1 library

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.
AnalyzeEntitiesRequest: The request to analyze healthcare entities in a document.
AnalyzeEntitiesResponse: Includes recognized entity mentions and relationships between them.
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.
Binding: Associates members, or principals, with a role.
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.
Consent: 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.
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.
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.
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.
EvaluateUserConsentsRequest: Evaluate a user's Consents for all matching User data mappings.
EvaluateUserConsentsResponse
ExportDicomDataRequest: Exports data from the specified DICOM store.
ExportMessagesRequest: Request to schedule an export.
ExportResourcesRequest: Request to export resources.
Feature: A feature of an entity mention.
FhirConfig: Specifies how to handle de-identification of a FHIR store.
FhirFilter: Filter configuration.
FhirNotificationConfig: Contains the configuration for FHIR notifications.
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.
GcsDestination: The Cloud Storage output destination.
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.
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.
GoogleCloudHealthcareV1DicomStreamConfig: StreamConfig specifies configuration for a streaming DICOM export.
GoogleCloudHealthcareV1FhirBigQueryDestination: The configuration for exporting to BigQuery.
GoogleCloudHealthcareV1FhirGcsDestination: The configuration for exporting to 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.
Hl7V2StoreMetric: Count of messages and total storage size by type for a given HL7 store.
Hl7V2StoreMetrics: List of metrics for a given HL7v2 store.
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.
ImportMessagesRequest: Request to import messages.
ImportResourcesRequest: Request to import 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.
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. confidence.
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
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.
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.
ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsResource
ProjectsLocationsDatasetsConsentStoresConsentArtifactsResource
ProjectsLocationsDatasetsConsentStoresConsentsResource
ProjectsLocationsDatasetsConsentStoresResource
ProjectsLocationsDatasetsConsentStoresUserDataMappingsResource
ProjectsLocationsDatasetsDataMapperWorkspacesResource
ProjectsLocationsDatasetsDicomStoresDicomWebResource
ProjectsLocationsDatasetsDicomStoresDicomWebStudiesResource
ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesResource
ProjectsLocationsDatasetsDicomStoresResource
ProjectsLocationsDatasetsDicomStoresStudiesResource
ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesResource
ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesResource
ProjectsLocationsDatasetsDicomStoresStudiesSeriesResource
ProjectsLocationsDatasetsFhirStoresFhirResource
ProjectsLocationsDatasetsFhirStoresResource
ProjectsLocationsDatasetsHl7V2StoresMessagesResource
ProjectsLocationsDatasetsHl7V2StoresResource
ProjectsLocationsDatasetsOperationsResource
ProjectsLocationsDatasetsResource
ProjectsLocationsResource
ProjectsLocationsServicesNlpResource
ProjectsLocationsServicesResource
ProjectsResource
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.
RejectConsentRequest: Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED.
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
RollbackFhirResourcesRequest
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.
SeriesMetrics: SeriesMetrics contains metrics describing a DICOM series.
SetIamPolicyRequest: Request message for SetIamPolicy method.
Signature: User signature.
StreamConfig: Contains configuration for streaming FHIR export.
StudyMetrics: StudyMetrics contains metrics describing a DICOM study.
TagFilterList: List of tags to be filtered.
TextConfig
TextSpan: A span of text in the provided document.
TimePartitioning: Configuration for FHIR BigQuery time-partitioned tables.
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.

Typedefs

ArchiveUserDataMappingRequest = $Empty: Archives the specified User data mapping.
ArchiveUserDataMappingResponse = $Empty: Archives the specified User data mapping.
AuditLogConfig = $AuditLogConfig: Provides the configuration for logging a type of permissions.
CancelOperationRequest = $Empty: The request message for Operations.CancelOperation.
Empty = $Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
Expr = $Expr: Represents a textual expression in the Common Expression Language (CEL) syntax.
GcsSource = $GcsSource: Specifies the configuration for importing data from Cloud Storage.
GoogleCloudHealthcareV1FhirGcsSource = $GcsSource: Specifies the configuration for importing data from Cloud Storage.
HttpBody = $HttpBody: Message that represents an arbitrary HTTP body.
Location = $Location00: A resource that represents a Google Cloud location.
RedactConfig = $Empty: Define how to redact sensitive values.
ReplaceWithInfoTypeConfig = $Empty: When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type.
Status = $Status: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
TestIamPermissionsRequest = $TestIamPermissionsRequest00: Request message for TestIamPermissions method.
TestIamPermissionsResponse = $PermissionsResponse: Response message for TestIamPermissions method.

Exceptions / Errors

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

healthcare/v1 library

Classes

Typedefs

Exceptions / Errors

googleapis package

v1 library